From 6515578b7e6989fd9a1bb513486b381e72fa81c0 Mon Sep 17 00:00:00 2001 From: sashahdo <64434373+sashahdo@users.noreply.github.com> Date: Tue, 26 Oct 2021 17:30:59 -0700 Subject: [PATCH 01/19] [Hub Generated] Review request for Microsoft.Consumption to add version stable/2019-10-01 (#16503) * Lowered minItems to 0 to match API implementation * Added missing ThresholdType value. --- .../Microsoft.Consumption/stable/2019-11-01/consumption.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-11-01/consumption.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-11-01/consumption.json index 3485df1dd9e3..43d7b5055869 100644 --- a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-11-01/consumption.json +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-11-01/consumption.json @@ -4162,7 +4162,8 @@ "description": "The type of threshold", "type": "string", "enum": [ - "Actual" + "Actual", + "Forecasted" ], "x-ms-enum": { "name": "ThresholdType", From 3a96589e3ec3a3123688cb76cda8fa694433e26a Mon Sep 17 00:00:00 2001 From: Caihua Rui <71814127+CaihuaRui@users.noreply.github.com> Date: Wed, 27 Oct 2021 13:20:14 +0800 Subject: [PATCH 02/19] Review request for Microsoft.AppPlatform to add a new field containerProbeSettings to DeploymentSettings in version 2021-09-01-preview (#16545) --- .../preview/2021-09-01-preview/appplatform.json | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2021-09-01-preview/appplatform.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2021-09-01-preview/appplatform.json index ff38bf79b376..4e96f4b01cf5 100644 --- a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2021-09-01-preview/appplatform.json +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2021-09-01-preview/appplatform.json @@ -4810,6 +4810,16 @@ "name": "RuntimeVersion", "modelAsString": true } + }, + "containerProbeSettings": { + "description": "Container liveness and readiness probe settings", + "type": "object", + "properties": { + "disableProbe": { + "description": "Indicates whether disable the liveness and readiness probe", + "type": "boolean" + } + } } } }, From f6a8a2ef54e892943b8c32358b2d731e01441d00 Mon Sep 17 00:00:00 2001 From: Yuchao Yan Date: Wed, 27 Oct 2021 14:18:13 +0800 Subject: [PATCH 03/19] Update CODEOWNERS (#16562) --- CODEOWNERS | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CODEOWNERS b/CODEOWNERS index f770b4351641..f0c911b79847 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -85,4 +85,4 @@ /specification/**/resource-manager/**/readme.az.md @jsntcy @qiaozha /specification/**/resource-manager/**/readme.cli.md @jsntcy @qiaozha /specification/**/resource-manager/**/readme.go.md @ArcturusZhang -/specification/**/resource-manager/**/readme.python.md @jsntcy @msyyc @zhangyan133 @RAY-316 @00Kai0 +/specification/**/resource-manager/**/readme.python.md @msyyc @RAY-316 @BigCat20196 From 94afa345211759e1f109f325dcdfcd56cf933c0a Mon Sep 17 00:00:00 2001 From: sukodava <78733210+sukodava@users.noreply.github.com> Date: Thu, 28 Oct 2021 06:46:53 +0530 Subject: [PATCH 04/19] Remove Provisioning Details from RestorePoint (#16099) * Add blockchain to latest profile * Add additional types * Remove Provisioning Details from RestorePoint * Fix prettier * JSON format * fix * Change 'timeCreated' Co-authored-by: Mark Cowlishaw --- .../examples/CreateAnSshPublicKey.json | 72 +++++++++---------- .../stable/2021-03-01/compute.json | 32 ++------- .../examples/CreateARestorePoint.json | 7 +- .../2021-03-01/examples/GetRestorePoint.json | 7 +- ...tCollectionWithContainedRestorePoints.json | 7 +- .../stable/2021-04-01/compute.json | 32 ++------- .../examples/CreateARestorePoint.json | 7 +- .../2021-04-01/examples/GetRestorePoint.json | 7 +- ...tCollectionWithContainedRestorePoints.json | 7 +- .../stable/2021-07-01/compute.json | 32 ++------- .../examples/compute/CreateARestorePoint.json | 7 +- .../examples/compute/GetRestorePoint.json | 7 +- ...tCollectionWithContainedRestorePoints.json | 7 +- 13 files changed, 57 insertions(+), 174 deletions(-) diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-12-01/examples/CreateAnSshPublicKey.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-12-01/examples/CreateAnSshPublicKey.json index 00074b2b3fd1..c1d79087d42e 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-12-01/examples/CreateAnSshPublicKey.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-12-01/examples/CreateAnSshPublicKey.json @@ -1,36 +1,36 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "api-version": "2019-12-01", - "sshPublicKeyName": "mySshPublicKeyName", - "parameters": { - "location": "westus", - "properties": { - "publicKey": "{ssh-rsa public key}" - } - } - }, - "responses": { - "200": { - "body": { - "name": "mySshPublicKeyName", - "location": "westus", - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/sshPublicKeys/mySshPublicKeyName", - "properties": { - "publicKey": "{ssh-rsa public key}" - } - } - }, - "201": { - "body": { - "name": "mySshPublicKeyName", - "location": "westus", - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/sshPublicKeys/mySshPublicKeyName", - "properties": { - "publicKey": "{ssh-rsa public key}" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2019-12-01", + "sshPublicKeyName": "mySshPublicKeyName", + "parameters": { + "location": "westus", + "properties": { + "publicKey": "{ssh-rsa public key}" + } + } + }, + "responses": { + "200": { + "body": { + "name": "mySshPublicKeyName", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/sshPublicKeys/mySshPublicKeyName", + "properties": { + "publicKey": "{ssh-rsa public key}" + } + } + }, + "201": { + "body": { + "name": "mySshPublicKeyName", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/sshPublicKeys/mySshPublicKeyName", + "properties": { + "publicKey": "{ssh-rsa public key}" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/compute.json index 9a24d89f48a2..24ee58dfde72 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/compute.json @@ -7635,30 +7635,6 @@ }, "description": "Describes a data disk." }, - "RestorePointProvisioningDetails": { - "properties": { - "creationTime": { - "type": "string", - "format": "date-time", - "description": "Gets the creation time of the restore point." - }, - "totalUsedSizeInBytes": { - "type": "integer", - "format": "int64", - "description": "Gets the total size of the data in all the disks which are part of the restore point." - }, - "statusCode": { - "type": "integer", - "format": "int32", - "description": "Gets the status of the Create restore point operation." - }, - "statusMessage": { - "type": "string", - "description": "Gets the status message of the Create restore point operation." - } - }, - "description": "Restore Point Provisioning details." - }, "RestorePoint": { "properties": { "properties": { @@ -7707,10 +7683,10 @@ }, "description": "Gets the consistency mode for the restore point. Please refer to https://aka.ms/RestorePoints for more details." }, - "provisioningDetails": { - "$ref": "#/definitions/RestorePointProvisioningDetails", - "readOnly": true, - "description": "Gets the provisioning details set by the server during Create restore point operation." + "timeCreated": { + "type": "string", + "format": "date-time", + "description": "Gets the creation time of the restore point." } }, "description": "The restore point properties." diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/examples/CreateARestorePoint.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/examples/CreateARestorePoint.json index 0e147d3d62db..8b9aec14420c 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/examples/CreateARestorePoint.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/examples/CreateARestorePoint.json @@ -79,12 +79,7 @@ }, "provisioningState": "Succeeded", "consistencyMode": "ApplicationConsistent", - "provisioningDetails": { - "creationTime": "2021-01-27T20:35:05.8401519+00:00", - "totalUsedSizeInBytes": 10835349504, - "statusCode": 0, - "statusMessage": "{\"jobMessage\":\"\",\"messageStr\":\"1/27/2021 8:35:56 PM , snapshotCreator=guestExtension, hostStatusCodePreSnapshot=200, Plugin enable Succeeded (command: Snapshot) Snapshot command completed \",\"snapshotConsistency\":2}" - } + "timeCreated": "2021-01-27T20:35:05.8401519+00:00" } } } diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/examples/GetRestorePoint.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/examples/GetRestorePoint.json index 989bc1353c3b..7d63a024de25 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/examples/GetRestorePoint.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/examples/GetRestorePoint.json @@ -70,12 +70,7 @@ }, "provisioningState": "Succeeded", "consistencyMode": "ApplicationConsistent", - "provisioningDetails": { - "creationTime": "2021-01-27T20:35:05.8401519+00:00", - "totalUsedSizeInBytes": 10835349504, - "statusCode": 0, - "statusMessage": "{\"jobMessage\":\"\",\"messageStr\":\"1/27/2021 8:35:56 PM , snapshotCreator=guestExtension, hostStatusCodePreSnapshot=200, Plugin enable Succeeded (command: Snapshot) Snapshot command completed \",\"snapshotConsistency\":2}" - } + "timeCreated": "2021-01-27T20:35:05.8401519+00:00" } } } diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/examples/GetRestorePointCollectionWithContainedRestorePoints.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/examples/GetRestorePointCollectionWithContainedRestorePoints.json index fcdefbc18c78..7755fe14eac3 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/examples/GetRestorePointCollectionWithContainedRestorePoints.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/examples/GetRestorePointCollectionWithContainedRestorePoints.json @@ -86,12 +86,7 @@ }, "provisioningState": "Succeeded", "consistencyMode": "ApplicationConsistent", - "provisioningDetails": { - "creationTime": "2021-01-27T20:35:05.8401519+00:00", - "totalUsedSizeInBytes": 10835349504, - "statusCode": 0, - "statusMessage": "{\"jobMessage\":\"\",\"messageStr\":\"1/27/2021 8:35:56 PM , snapshotCreator=guestExtension, hostStatusCodePreSnapshot=200, Plugin enable Succeeded (command: Snapshot) Snapshot command completed \",\"snapshotConsistency\":2}" - } + "timeCreated": "2021-01-27T20:35:05.8401519+00:00" } } ] diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/compute.json index c3338cddd6a8..1ae8cdc6f627 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/compute.json @@ -8293,30 +8293,6 @@ }, "description": "Describes a data disk." }, - "RestorePointProvisioningDetails": { - "properties": { - "creationTime": { - "type": "string", - "format": "date-time", - "description": "Gets the creation time of the restore point." - }, - "totalUsedSizeInBytes": { - "type": "integer", - "format": "int64", - "description": "Gets the total size of the data in all the disks which are part of the restore point." - }, - "statusCode": { - "type": "integer", - "format": "int32", - "description": "Gets the status of the Create restore point operation." - }, - "statusMessage": { - "type": "string", - "description": "Gets the status message of the Create restore point operation." - } - }, - "description": "Restore Point Provisioning details." - }, "RestorePoint": { "properties": { "properties": { @@ -8365,10 +8341,10 @@ }, "description": "Gets the consistency mode for the restore point. Please refer to https://aka.ms/RestorePoints for more details." }, - "provisioningDetails": { - "$ref": "#/definitions/RestorePointProvisioningDetails", - "readOnly": true, - "description": "Gets the provisioning details set by the server during Create restore point operation." + "timeCreated": { + "type": "string", + "format": "date-time", + "description": "Gets the creation time of the restore point." } }, "description": "The restore point properties." diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateARestorePoint.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateARestorePoint.json index d6ea9279f204..c1f274a81fa2 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateARestorePoint.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateARestorePoint.json @@ -79,12 +79,7 @@ }, "provisioningState": "Succeeded", "consistencyMode": "ApplicationConsistent", - "provisioningDetails": { - "creationTime": "2021-01-27T20:35:05.8401519+00:00", - "totalUsedSizeInBytes": 10835349504, - "statusCode": 0, - "statusMessage": "{\"jobMessage\":\"\",\"messageStr\":\"1/27/2021 8:35:56 PM , snapshotCreator=guestExtension, hostStatusCodePreSnapshot=200, Plugin enable Succeeded (command: Snapshot) Snapshot command completed \",\"snapshotConsistency\":2}" - } + "timeCreated": "2021-01-27T20:35:05.8401519+00:00" } } } diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetRestorePoint.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetRestorePoint.json index 08a2c87d845a..68c69456dd49 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetRestorePoint.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetRestorePoint.json @@ -70,12 +70,7 @@ }, "provisioningState": "Succeeded", "consistencyMode": "ApplicationConsistent", - "provisioningDetails": { - "creationTime": "2021-01-27T20:35:05.8401519+00:00", - "totalUsedSizeInBytes": 10835349504, - "statusCode": 0, - "statusMessage": "{\"jobMessage\":\"\",\"messageStr\":\"1/27/2021 8:35:56 PM , snapshotCreator=guestExtension, hostStatusCodePreSnapshot=200, Plugin enable Succeeded (command: Snapshot) Snapshot command completed \",\"snapshotConsistency\":2}" - } + "timeCreated": "2021-01-27T20:35:05.8401519+00:00" } } } diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetRestorePointCollectionWithContainedRestorePoints.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetRestorePointCollectionWithContainedRestorePoints.json index e8c954c155b9..2b5f20369d9c 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetRestorePointCollectionWithContainedRestorePoints.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetRestorePointCollectionWithContainedRestorePoints.json @@ -86,12 +86,7 @@ }, "provisioningState": "Succeeded", "consistencyMode": "ApplicationConsistent", - "provisioningDetails": { - "creationTime": "2021-01-27T20:35:05.8401519+00:00", - "totalUsedSizeInBytes": 10835349504, - "statusCode": 0, - "statusMessage": "{\"jobMessage\":\"\",\"messageStr\":\"1/27/2021 8:35:56 PM , snapshotCreator=guestExtension, hostStatusCodePreSnapshot=200, Plugin enable Succeeded (command: Snapshot) Snapshot command completed \",\"snapshotConsistency\":2}" - } + "timeCreated": "2021-01-27T20:35:05.8401519+00:00" } } ] diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-07-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-07-01/compute.json index d2f1146593c7..5a442cef1a2a 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-07-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-07-01/compute.json @@ -8326,30 +8326,6 @@ }, "description": "Describes a data disk." }, - "RestorePointProvisioningDetails": { - "properties": { - "creationTime": { - "type": "string", - "format": "date-time", - "description": "Gets the creation time of the restore point." - }, - "totalUsedSizeInBytes": { - "type": "integer", - "format": "int64", - "description": "Gets the total size of the data in all the disks which are part of the restore point." - }, - "statusCode": { - "type": "integer", - "format": "int32", - "description": "Gets the status of the Create restore point operation." - }, - "statusMessage": { - "type": "string", - "description": "Gets the status message of the Create restore point operation." - } - }, - "description": "Restore Point Provisioning details." - }, "RestorePoint": { "properties": { "properties": { @@ -8398,10 +8374,10 @@ }, "description": "Gets the consistency mode for the restore point. Please refer to https://aka.ms/RestorePoints for more details." }, - "provisioningDetails": { - "$ref": "#/definitions/RestorePointProvisioningDetails", - "readOnly": true, - "description": "Gets the provisioning details set by the server during Create restore point operation." + "timeCreated": { + "type": "string", + "format": "date-time", + "description": "Gets the creation time of the restore point." } }, "description": "The restore point properties." diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-07-01/examples/compute/CreateARestorePoint.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-07-01/examples/compute/CreateARestorePoint.json index 7cff97e632cd..fc5b22570e60 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-07-01/examples/compute/CreateARestorePoint.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-07-01/examples/compute/CreateARestorePoint.json @@ -79,12 +79,7 @@ }, "provisioningState": "Succeeded", "consistencyMode": "ApplicationConsistent", - "provisioningDetails": { - "creationTime": "2021-01-27T20:35:05.8401519+00:00", - "totalUsedSizeInBytes": 10835349504, - "statusCode": 0, - "statusMessage": "{\"jobMessage\":\"\",\"messageStr\":\"1/27/2021 8:35:56 PM , snapshotCreator=guestExtension, hostStatusCodePreSnapshot=200, Plugin enable Succeeded (command: Snapshot) Snapshot command completed \",\"snapshotConsistency\":2}" - } + "timeCreated": "2021-01-27T20:35:05.8401519+00:00" } } } diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-07-01/examples/compute/GetRestorePoint.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-07-01/examples/compute/GetRestorePoint.json index d616fabdc9e8..2d330d636dfc 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-07-01/examples/compute/GetRestorePoint.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-07-01/examples/compute/GetRestorePoint.json @@ -70,12 +70,7 @@ }, "provisioningState": "Succeeded", "consistencyMode": "ApplicationConsistent", - "provisioningDetails": { - "creationTime": "2021-01-27T20:35:05.8401519+00:00", - "totalUsedSizeInBytes": 10835349504, - "statusCode": 0, - "statusMessage": "{\"jobMessage\":\"\",\"messageStr\":\"1/27/2021 8:35:56 PM , snapshotCreator=guestExtension, hostStatusCodePreSnapshot=200, Plugin enable Succeeded (command: Snapshot) Snapshot command completed \",\"snapshotConsistency\":2}" - } + "timeCreated": "2021-01-27T20:35:05.8401519+00:00" } } } diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-07-01/examples/compute/GetRestorePointCollectionWithContainedRestorePoints.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-07-01/examples/compute/GetRestorePointCollectionWithContainedRestorePoints.json index ce9d3b156fa8..b4d13ce0ace1 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-07-01/examples/compute/GetRestorePointCollectionWithContainedRestorePoints.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-07-01/examples/compute/GetRestorePointCollectionWithContainedRestorePoints.json @@ -86,12 +86,7 @@ }, "provisioningState": "Succeeded", "consistencyMode": "ApplicationConsistent", - "provisioningDetails": { - "creationTime": "2021-01-27T20:35:05.8401519+00:00", - "totalUsedSizeInBytes": 10835349504, - "statusCode": 0, - "statusMessage": "{\"jobMessage\":\"\",\"messageStr\":\"1/27/2021 8:35:56 PM , snapshotCreator=guestExtension, hostStatusCodePreSnapshot=200, Plugin enable Succeeded (command: Snapshot) Snapshot command completed \",\"snapshotConsistency\":2}" - } + "timeCreated": "2021-01-27T20:35:05.8401519+00:00" } } ] From d5ccfc1bdd7711cfdcdca801371100540f331f59 Mon Sep 17 00:00:00 2001 From: Robert Gao Date: Wed, 27 Oct 2021 18:54:41 -0700 Subject: [PATCH 05/19] Revert "Robga/policy (#16255)" (#16537) This reverts commit 780a637142214a458a74db73a230dd0b1384eb2a. --- .../createOrUpdatePolicyExemption.json | 79 --- .../examples/createOrUpdatePolicyPricing.json | 54 -- .../examples/deletePolicyExemption.json | 15 - .../examples/deletePolicyPricing.json | 21 - .../examples/getPolicyExemption.json | 37 -- .../2021-07-01/examples/getPolicyPricing.json | 29 - ...istPolicyExemptionsForManagementGroup.json | 63 -- .../listPolicyExemptionsForResource.json | 67 --- .../listPolicyExemptionsForResourceGroup.json | 64 -- .../listPolicyExemptionsForSubscription.json | 63 -- .../listPolicyPricingsForManagementGroup.json | 49 -- .../listPolicyPricingsForSubscription.json | 49 -- .../stable/2021-07-01/policyExemptions.json | 564 ------------------ .../stable/2021-07-01/policyPricings.json | 430 ------------- .../resources/resource-manager/readme.go.md | 11 - .../resources/resource-manager/readme.java.md | 19 - .../resources/resource-manager/readme.md | 32 +- .../resource-manager/readme.python.md | 11 - 18 files changed, 1 insertion(+), 1656 deletions(-) delete mode 100644 specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/examples/createOrUpdatePolicyExemption.json delete mode 100644 specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/examples/createOrUpdatePolicyPricing.json delete mode 100644 specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/examples/deletePolicyExemption.json delete mode 100644 specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/examples/deletePolicyPricing.json delete mode 100644 specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/examples/getPolicyExemption.json delete mode 100644 specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/examples/getPolicyPricing.json delete mode 100644 specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/examples/listPolicyExemptionsForManagementGroup.json delete mode 100644 specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/examples/listPolicyExemptionsForResource.json delete mode 100644 specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/examples/listPolicyExemptionsForResourceGroup.json delete mode 100644 specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/examples/listPolicyExemptionsForSubscription.json delete mode 100644 specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/examples/listPolicyPricingsForManagementGroup.json delete mode 100644 specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/examples/listPolicyPricingsForSubscription.json delete mode 100644 specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/policyExemptions.json delete mode 100644 specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/policyPricings.json diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/examples/createOrUpdatePolicyExemption.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/examples/createOrUpdatePolicyExemption.json deleted file mode 100644 index c98a998c2647..000000000000 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/examples/createOrUpdatePolicyExemption.json +++ /dev/null @@ -1,79 +0,0 @@ -{ - "parameters": { - "scope": "subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/demoCluster", - "policyExemptionName": "DemoExpensiveVM", - "api-version": "2021-07-01", - "parameters": { - "properties": { - "policyAssignmentId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/CostManagement", - "policyDefinitionReferenceIds": [ - "Limit_Skus" - ], - "exemptionCategory": "Waiver", - "displayName": "Exempt demo cluster", - "description": "Exempt demo cluster from limit sku", - "metadata": { - "reason": "Temporary exemption for a expensive VM demo" - } - } - } - }, - "responses": { - "201": { - "headers": {}, - "body": { - "properties": { - "policyAssignmentId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/CostManagement", - "policyDefinitionReferenceIds": [ - "Limit_Skus" - ], - "exemptionCategory": "Waiver", - "displayName": "Exempt demo cluster", - "description": "Exempt demo cluster from limit sku", - "metadata": { - "reason": "Temporary exemption for a expensive VM demo" - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2021-07-01T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2021-07-01T01:01:01.1075056Z" - }, - "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/demoCluster/providers/Microsoft.Authorization/policyExemptions/DemoExpensiveVM", - "type": "Microsoft.Authorization/policyExemptions", - "name": "DemoExpensiveVM" - } - }, - "200": { - "headers": {}, - "body": { - "properties": { - "policyAssignmentId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/CostManagement", - "policyDefinitionReferenceIds": [ - "Limit_Skus" - ], - "exemptionCategory": "Waiver", - "displayName": "Exempt demo cluster", - "description": "Exempt demo cluster from limit sku", - "metadata": { - "reason": "Temporary exemption for a expensive VM demo" - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2021-07-01T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2021-07-01T02:01:01.1075056Z" - }, - "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/demoCluster/providers/Microsoft.Authorization/policyExemptions/DemoExpensiveVM", - "type": "Microsoft.Authorization/policyExemptions", - "name": "DemoExpensiveVM" - } - } - } -} diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/examples/createOrUpdatePolicyPricing.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/examples/createOrUpdatePolicyPricing.json deleted file mode 100644 index 2552462b8770..000000000000 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/examples/createOrUpdatePolicyPricing.json +++ /dev/null @@ -1,54 +0,0 @@ -{ - "parameters": { - "scope": "providers/Microsoft.Management/managementGroups/HardwareDivision", - "policyPricingName": "Advanced", - "api-version": "2021-07-01", - "parameters": { - "properties": { - "pricingTier": "Advanced" - } - } - }, - "responses": { - "201": { - "headers": {}, - "body": { - "properties": { - "pricingTier": "Advanced", - "provisioningState": "Accepted" - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2021-07-01T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2021-07-01T01:01:01.1075056Z" - }, - "id": "/providers/Microsoft.Management/managementGroups/HardwareDivision/providers/Microsoft.Authorization/policyPricings/Advanced", - "type": "Microsoft.Authorization/policyPricings", - "name": "Advanced" - } - }, - "200": { - "headers": {}, - "body": { - "properties": { - "pricingTier": "Advanced", - "provisioningState": "Succeeded" - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2021-07-01T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2021-07-01T02:01:01.1075056Z" - }, - "id": "/providers/Microsoft.Management/managementGroups/HardwareDivision/providers/Microsoft.Authorization/policyPricings/Advanced", - "type": "Microsoft.Authorization/policyPricings", - "name": "Advanced" - } - } - } -} diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/examples/deletePolicyExemption.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/examples/deletePolicyExemption.json deleted file mode 100644 index 0f2792cb723d..000000000000 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/examples/deletePolicyExemption.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "parameters": { - "scope": "subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/demoCluster", - "policyExemptionName": "DemoExpensiveVM", - "api-version": "2021-07-01" - }, - "responses": { - "200": { - "headers": {} - }, - "204": { - "headers": {} - } - } -} diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/examples/deletePolicyPricing.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/examples/deletePolicyPricing.json deleted file mode 100644 index 4919ee1f8ecd..000000000000 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/examples/deletePolicyPricing.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "parameters": { - "scope": "providers/Microsoft.Management/managementGroups/HardwareDivision", - "policyPricingName": "Advanced", - "api-version": "2021-07-01" - }, - "responses": { - "200": { - "headers": {} - }, - "202": { - "headers": { - "location": "https://management.azure.com/providers/Microsoft.Management/managementGroups/HardwareDivision/providers/Microsoft.Authorization/policyPricingOperationResults/c9bbccf4-e16a-4eb7-befb-2e2e5195c347?api-version=2021-07-01", - "retry-after": "30" - } - }, - "204": { - "headers": {} - } - } -} diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/examples/getPolicyExemption.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/examples/getPolicyExemption.json deleted file mode 100644 index 3b90fd327d96..000000000000 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/examples/getPolicyExemption.json +++ /dev/null @@ -1,37 +0,0 @@ -{ - "parameters": { - "scope": "subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/demoCluster", - "policyExemptionName": "DemoExpensiveVM", - "api-version": "2021-07-01" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "properties": { - "policyAssignmentId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/CostManagement", - "policyDefinitionReferenceIds": [ - "Limit_Skus" - ], - "exemptionCategory": "Waiver", - "displayName": "Exempt demo cluster", - "description": "Exempt demo cluster from limit sku", - "metadata": { - "reason": "Temporary exemption for a expensive VM demo" - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2021-07-01T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2021-07-01T02:01:01.1075056Z" - }, - "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/demoCluster/providers/Microsoft.Authorization/policyExemptions/DemoExpensiveVM", - "type": "Microsoft.Authorization/policyExemptions", - "name": "DemoExpensiveVM" - } - } - } -} diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/examples/getPolicyPricing.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/examples/getPolicyPricing.json deleted file mode 100644 index 968c1d9e4b06..000000000000 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/examples/getPolicyPricing.json +++ /dev/null @@ -1,29 +0,0 @@ -{ - "parameters": { - "scope": "subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2", - "policyPricingName": "Advanced", - "api-version": "2021-07-01" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "properties": { - "pricingTier": "Advanced", - "provisioningState": "Succeeded" - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2021-07-01T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2021-07-01T01:01:01.1075056Z" - }, - "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyPricings/Advanced", - "type": "Microsoft.Authorization/policyPricings", - "name": "Advanced" - } - } - } -} diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/examples/listPolicyExemptionsForManagementGroup.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/examples/listPolicyExemptionsForManagementGroup.json deleted file mode 100644 index bd5c7c40aba9..000000000000 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/examples/listPolicyExemptionsForManagementGroup.json +++ /dev/null @@ -1,63 +0,0 @@ -{ - "parameters": { - "managementGroupId": "DevOrg", - "api-version": "2021-07-01", - "$filter": "atScope()" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "properties": { - "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/HardwareDivision/providers/Microsoft.Authorization/policyAssignments/CostManagement", - "policyDefinitionReferenceIds": [ - "Limit_Skus" - ], - "exemptionCategory": "Waiver", - "displayName": "Exempt demo cluster", - "description": "Exempt demo cluster from limit sku", - "metadata": { - "reason": "Temporary exemption for a expensive VM demo" - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2021-07-01T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2021-07-01T02:01:01.1075056Z" - }, - "id": "/providers/Microsoft.Management/managementGroups/DevOrg/providers/Microsoft.Authorization/policyExemptions/ResearchBudgetExemption", - "type": "Microsoft.Authorization/policyExemptions", - "name": "ResearchBudgetExemption" - }, - { - "properties": { - "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/HardwareDivision/providers/Microsoft.Authorization/policyAssignments/LimitPorts", - "exemptionCategory": "Mitigated", - "displayName": "Exempt jump box open ports", - "description": "Exempt jump box open ports from limit ports policy", - "metadata": { - "reason": "Need to open RDP port to corp net" - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2021-07-01T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2021-07-01T02:01:01.1075056Z" - }, - "id": "/providers/Microsoft.Management/managementGroups/DevOrg/providers/Microsoft.Authorization/policyExemptions/VNetIsMonitored", - "type": "Microsoft.Authorization/policyExemptions", - "name": "VNetIsMonitored" - } - ] - } - } - } -} diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/examples/listPolicyExemptionsForResource.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/examples/listPolicyExemptionsForResource.json deleted file mode 100644 index 176bc9bfd18f..000000000000 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/examples/listPolicyExemptionsForResource.json +++ /dev/null @@ -1,67 +0,0 @@ -{ - "parameters": { - "subscriptionId": "ae640e6b-ba3e-4256-9d62-2993eecfa6f2", - "resourceGroupName": "TestResourceGroup", - "resourceProviderNamespace": "Microsoft.Compute", - "parentResourcePath": "virtualMachines/MyTestVm", - "resourceType": "domainNames", - "resourceName": "MyTestComputer.cloudapp.net", - "api-version": "2021-07-01" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "properties": { - "policyAssignmentId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/CostManagement", - "policyDefinitionReferenceIds": [ - "Limit_Skus" - ], - "exemptionCategory": "Waiver", - "displayName": "Exempt demo cluster", - "description": "Exempt demo cluster from limit sku", - "metadata": { - "reason": "Temporary exemption for a expensive VM demo" - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2021-07-01T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2021-07-01T02:01:01.1075056Z" - }, - "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/TestResourceGroup/providers/Microsoft.Authorization/policyExemptions/DemoExpensiveVMGroup", - "type": "Microsoft.Authorization/policyExemptions", - "name": "DemoExpensiveVMGroup" - }, - { - "properties": { - "policyAssignmentId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/LimitPorts", - "exemptionCategory": "Mitigated", - "displayName": "Exempt jump box open ports", - "description": "Exempt jump box open ports from limit ports policy", - "metadata": { - "reason": "Need to open RDP port to corp net" - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2021-07-01T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2021-07-01T02:01:01.1075056Z" - }, - "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/TestResourceGroup/providers/Microsoft.Compute/virtualMachines/MyTestVm/providers/Microsoft.Authorization/policyExemptions/jumpBoxExemption", - "type": "Microsoft.Authorization/policyExemptions", - "name": "jumpBoxExemption" - } - ] - } - } - } -} diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/examples/listPolicyExemptionsForResourceGroup.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/examples/listPolicyExemptionsForResourceGroup.json deleted file mode 100644 index c9402a0245bc..000000000000 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/examples/listPolicyExemptionsForResourceGroup.json +++ /dev/null @@ -1,64 +0,0 @@ -{ - "parameters": { - "subscriptionId": "ae640e6b-ba3e-4256-9d62-2993eecfa6f2", - "resourceGroupName": "TestResourceGroup", - "api-version": "2021-07-01", - "$filter": "atScope()" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "properties": { - "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/DevOrg/providers/Microsoft.Authorization/policyAssignments/CostManagement", - "policyDefinitionReferenceIds": [ - "Limit_Skus" - ], - "exemptionCategory": "Waiver", - "displayName": "Exempt demo cluster", - "description": "Exempt demo cluster from limit sku", - "metadata": { - "reason": "Temporary exemption for a expensive VM demo" - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2021-07-01T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2021-07-01T02:01:01.1075056Z" - }, - "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyExemptions/TestVMSub", - "type": "Microsoft.Authorization/policyExemptions", - "name": "TestVMSub" - }, - { - "properties": { - "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/DevOrg/providers/Microsoft.Authorization/policyAssignments/LimitPorts", - "exemptionCategory": "Mitigated", - "displayName": "Exempt jump box open ports", - "description": "Exempt jump box open ports from limit ports policy", - "metadata": { - "reason": "Need to open RDP port to corp net" - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2021-07-01T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2021-07-01T02:01:01.1075056Z" - }, - "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/TestResourceGroup/providers/Microsoft.Authorization/policyExemptions/TestVNetRG", - "type": "Microsoft.Authorization/policyExemptions", - "name": "TestVNetRG" - } - ] - } - } - } -} diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/examples/listPolicyExemptionsForSubscription.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/examples/listPolicyExemptionsForSubscription.json deleted file mode 100644 index 26269d06f7de..000000000000 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/examples/listPolicyExemptionsForSubscription.json +++ /dev/null @@ -1,63 +0,0 @@ -{ - "parameters": { - "subscriptionId": "ae640e6b-ba3e-4256-9d62-2993eecfa6f2", - "api-version": "2021-07-01", - "$filter": "atScope()" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "properties": { - "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/DevOrg/providers/Microsoft.Authorization/policyAssignments/CostManagement", - "policyDefinitionReferenceIds": [ - "Limit_Skus" - ], - "exemptionCategory": "Waiver", - "displayName": "Exempt demo cluster", - "description": "Exempt demo cluster from limit sku", - "metadata": { - "reason": "Temporary exemption for a expensive VM demo" - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2021-07-01T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2021-07-01T02:01:01.1075056Z" - }, - "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyExemptions/TestVMSub", - "type": "Microsoft.Authorization/policyExemptions", - "name": "TestVMSub" - }, - { - "properties": { - "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/DevOrg/providers/Microsoft.Authorization/policyAssignments/LimitPorts", - "exemptionCategory": "Mitigated", - "displayName": "Exempt jump box open ports", - "description": "Exempt jump box open ports from limit ports policy", - "metadata": { - "reason": "Need to open RDP port to corp net" - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2021-07-01T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2021-07-01T02:01:01.1075056Z" - }, - "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyExemptions/TestVNetSub", - "type": "Microsoft.Authorization/policyExemptions", - "name": "TestVNetSub" - } - ] - } - } - } -} diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/examples/listPolicyPricingsForManagementGroup.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/examples/listPolicyPricingsForManagementGroup.json deleted file mode 100644 index c3ed0a510988..000000000000 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/examples/listPolicyPricingsForManagementGroup.json +++ /dev/null @@ -1,49 +0,0 @@ -{ - "parameters": { - "managementGroupId": "DevOrg", - "api-version": "2021-07-01" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "properties": { - "pricingTier": "Advanced", - "provisioningState": "Succeeded" - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2021-07-01T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2021-07-01T01:01:01.1075056Z" - }, - "id": "/providers/Microsoft.Management/managementGroups/HardwareDivision/providers/Microsoft.Authorization/policyPricings/Advanced", - "type": "Microsoft.Authorization/policyPricings", - "name": "Advanced" - }, - { - "properties": { - "pricingTier": "Advanced", - "provisioningState": "Succeeded" - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2021-07-01T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2021-07-01T01:01:01.1075056Z" - }, - "id": "/providers/Microsoft.Management/managementGroups/DevOrg/providers/Microsoft.Authorization/policyPricings/Advanced", - "type": "Microsoft.Authorization/policyPricings", - "name": "Advanced" - } - ] - } - } - } -} diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/examples/listPolicyPricingsForSubscription.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/examples/listPolicyPricingsForSubscription.json deleted file mode 100644 index ae6bfb20388a..000000000000 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/examples/listPolicyPricingsForSubscription.json +++ /dev/null @@ -1,49 +0,0 @@ -{ - "parameters": { - "subscriptionId": "ae640e6b-ba3e-4256-9d62-2993eecfa6f2", - "api-version": "2021-07-01" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "properties": { - "pricingTier": "Advanced", - "provisioningState": "Succeeded" - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2021-07-01T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2021-07-01T01:01:01.1075056Z" - }, - "id": "/providers/Microsoft.Management/managementGroups/DevOrg/providers/Microsoft.Authorization/policyPricings/Advanced", - "type": "Microsoft.Authorization/policyPricings", - "name": "Advanced" - }, - { - "properties": { - "pricingTier": "Advanced", - "provisioningState": "Succeeded" - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2021-07-01T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2021-07-01T01:01:01.1075056Z" - }, - "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyPricings/Advanced", - "type": "Microsoft.Authorization/policyPricings", - "name": "Advanced" - } - ] - } - } - } -} diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/policyExemptions.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/policyExemptions.json deleted file mode 100644 index b8b7c56591fe..000000000000 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/policyExemptions.json +++ /dev/null @@ -1,564 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "PolicyClient", - "version": "2021-07-01", - "description": "To exempt your resources from policy evaluation and non-compliance state, you can create an exemption at a scope." - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/{scope}/providers/Microsoft.Authorization/policyExemptions/{policyExemptionName}": { - "delete": { - "tags": [ - "PolicyExemptions" - ], - "operationId": "PolicyExemptions_Delete", - "summary": "Deletes a policy exemption.", - "description": "This operation deletes a policy exemption, given its name and the scope it was created in. The scope of a policy exemption is the part of its ID preceding '/providers/Microsoft.Authorization/policyExemptions/{policyExemptionName}'.", - "x-ms-examples": { - "Delete a policy exemption": { - "$ref": "./examples/deletePolicyExemption.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/PolicyExemptionScopeParameter" - }, - { - "$ref": "#/parameters/PolicyExemptionNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "204": { - "description": "No Content - the policy exemption doesn't exist." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "put": { - "tags": [ - "PolicyExemptions" - ], - "operationId": "PolicyExemptions_CreateOrUpdate", - "summary": "Creates or updates a policy exemption.", - "description": " This operation creates or updates a policy exemption with the given scope and name. Policy exemptions apply to all resources contained within their scope. For example, when you create a policy exemption at resource group scope for a policy assignment at the same or above level, the exemption exempts to all applicable resources in the resource group.", - "x-ms-examples": { - "Create or update a policy exemption": { - "$ref": "./examples/createOrUpdatePolicyExemption.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/PolicyExemptionScopeParameter" - }, - { - "$ref": "#/parameters/PolicyExemptionNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/PolicyExemption" - }, - "description": "Parameters for the policy exemption." - } - ], - "responses": { - "200": { - "description": "OK - Returns information about the updated policy exemption.", - "schema": { - "$ref": "#/definitions/PolicyExemption" - } - }, - "201": { - "description": "Created - Returns information about the new policy exemption.", - "schema": { - "$ref": "#/definitions/PolicyExemption" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "get": { - "tags": [ - "PolicyExemptions" - ], - "operationId": "PolicyExemptions_Get", - "summary": "Retrieves a policy exemption.", - "description": "This operation retrieves a single policy exemption, given its name and the scope it was created at.", - "x-ms-examples": { - "Retrieve a policy exemption": { - "$ref": "./examples/getPolicyExemption.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/PolicyExemptionScopeParameter" - }, - { - "$ref": "#/parameters/PolicyExemptionNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK - Returns information about the policy exemption.", - "schema": { - "$ref": "#/definitions/PolicyExemption" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyExemptions": { - "get": { - "tags": [ - "PolicyExemptions" - ], - "operationId": "PolicyExemptions_List", - "summary": "Retrieves all policy exemptions that apply to a subscription.", - "description": "This operation retrieves the list of all policy exemptions associated with the given subscription that match the optional given $filter. Valid values for $filter are: 'atScope()', 'atExactScope()', 'excludeExpired()' or 'policyAssignmentId eq '{value}''. If $filter is not provided, the unfiltered list includes all policy exemptions associated with the subscription, including those that apply directly or from management groups that contain the given subscription, as well as any applied to objects contained within the subscription.", - "x-ms-examples": { - "List policy exemptions that apply to a subscription": { - "$ref": "./examples/listPolicyExemptionsForSubscription.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/PolicyExemptionFilterParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK - Returns an array of policy exemptions.", - "schema": { - "$ref": "#/definitions/PolicyExemptionListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Authorization/policyExemptions": { - "get": { - "tags": [ - "PolicyExemptions" - ], - "operationId": "PolicyExemptions_ListForResourceGroup", - "summary": "Retrieves all policy exemptions that apply to a resource group.", - "description": "This operation retrieves the list of all policy exemptions associated with the given resource group in the given subscription that match the optional given $filter. Valid values for $filter are: 'atScope()', 'atExactScope()', 'excludeExpired()' or 'policyAssignmentId eq '{value}''. If $filter is not provided, the unfiltered list includes all policy exemptions associated with the resource group, including those that apply directly or apply from containing scopes, as well as any applied to resources contained within the resource group.", - "x-ms-examples": { - "List policy exemptions that apply to a resource group": { - "$ref": "./examples/listPolicyExemptionsForResourceGroup.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/PolicyExemptionFilterParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK - Returns an array of policy exemptions.", - "schema": { - "$ref": "#/definitions/PolicyExemptionListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}/providers/Microsoft.Authorization/policyExemptions": { - "get": { - "tags": [ - "PolicyExemptions" - ], - "operationId": "PolicyExemptions_ListForResource", - "summary": "Retrieves all policy exemptions that apply to a resource.", - "description": "This operation retrieves the list of all policy exemptions associated with the specified resource in the given resource group and subscription that match the optional given $filter. Valid values for $filter are: 'atScope()', 'atExactScope()', 'excludeExpired()' or 'policyAssignmentId eq '{value}''. If $filter is not provided, the unfiltered list includes all policy exemptions associated with the resource, including those that apply directly or from all containing scopes, as well as any applied to resources contained within the resource. Three parameters plus the resource name are used to identify a specific resource. If the resource is not part of a parent resource (the more common case), the parent resource path should not be provided (or provided as ''). For example a web app could be specified as ({resourceProviderNamespace} == 'Microsoft.Web', {parentResourcePath} == '', {resourceType} == 'sites', {resourceName} == 'MyWebApp'). If the resource is part of a parent resource, then all parameters should be provided. For example a virtual machine DNS name could be specified as ({resourceProviderNamespace} == 'Microsoft.Compute', {parentResourcePath} == 'virtualMachines/MyVirtualMachine', {resourceType} == 'domainNames', {resourceName} == 'MyComputerName'). A convenient alternative to providing the namespace and type name separately is to provide both in the {resourceType} parameter, format: ({resourceProviderNamespace} == '', {parentResourcePath} == '', {resourceType} == 'Microsoft.Web/sites', {resourceName} == 'MyWebApp').", - "x-ms-examples": { - "List all policy exemptions that apply to a resource": { - "$ref": "./examples/listPolicyExemptionsForResource.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "name": "resourceProviderNamespace", - "in": "path", - "required": true, - "type": "string", - "description": "The namespace of the resource provider. For example, the namespace of a virtual machine is Microsoft.Compute (from Microsoft.Compute/virtualMachines)" - }, - { - "name": "parentResourcePath", - "in": "path", - "required": true, - "type": "string", - "description": "The parent resource path. Use empty string if there is none.", - "x-ms-skip-url-encoding": true - }, - { - "name": "resourceType", - "in": "path", - "required": true, - "type": "string", - "description": "The resource type name. For example the type name of a web app is 'sites' (from Microsoft.Web/sites).", - "x-ms-skip-url-encoding": true - }, - { - "name": "resourceName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource." - }, - { - "$ref": "#/parameters/PolicyExemptionFilterParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK - Returns an array of policy exemptions.", - "schema": { - "$ref": "#/definitions/PolicyExemptionListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/policyExemptions": { - "get": { - "tags": [ - "PolicyExemptions" - ], - "operationId": "PolicyExemptions_ListForManagementGroup", - "summary": "Retrieves all policy exemptions that apply to a management group.", - "description": "This operation retrieves the list of all policy exemptions applicable to the management group that match the given $filter. Valid values for $filter are: 'atScope()', 'atExactScope()', 'excludeExpired()' or 'policyAssignmentId eq '{value}''. If $filter=atScope() is provided, the returned list includes all policy exemptions that are assigned to the management group or the management group's ancestors.", - "x-ms-examples": { - "List policy exemptions that apply to a management group": { - "$ref": "./examples/listPolicyExemptionsForManagementGroup.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ManagementGroupIdParameter" - }, - { - "$ref": "#/parameters/PolicyExemptionFilterParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK - Returns an array of policy exemptions.", - "schema": { - "$ref": "#/definitions/PolicyExemptionListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - } - }, - "definitions": { - "CloudError": { - "x-ms-external": true, - "properties": { - "error": { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse" - } - }, - "description": "An error response from a policy operation." - }, - "PolicyExemptionProperties": { - "type": "object", - "required": [ - "policyAssignmentId", - "exemptionCategory" - ], - "properties": { - "policyAssignmentId": { - "type": "string", - "description": "The ID of the policy assignment that is being exempted." - }, - "policyDefinitionReferenceIds": { - "type": "array", - "items": { - "type": "string" - }, - "description": "The policy definition reference ID list when the associated policy assignment is an assignment of a policy set definition." - }, - "exemptionCategory": { - "type": "string", - "description": "The policy exemption category. Possible values are Waiver and Mitigated.", - "enum": [ - "Waiver", - "Mitigated" - ], - "x-ms-enum": { - "name": "exemptionCategory", - "modelAsString": true, - "values": [ - { - "value": "Waiver", - "description": "This category of exemptions usually means the scope is not applicable for the policy." - }, - { - "value": "Mitigated", - "description": "This category of exemptions usually means the mitigation actions have been applied to the scope." - } - ] - } - }, - "expiresOn": { - "type": "string", - "format": "date-time", - "description": "The expiration date and time (in UTC ISO 8601 format yyyy-MM-ddTHH:mm:ssZ) of the policy exemption." - }, - "displayName": { - "type": "string", - "description": "The display name of the policy exemption." - }, - "description": { - "type": "string", - "description": "The description of the policy exemption." - }, - "metadata": { - "type": "object", - "description": "The policy exemption metadata. Metadata is an open ended object and is typically a collection of key value pairs." - } - }, - "description": "The policy exemption properties." - }, - "PolicyExemption": { - "type": "object", - "required": [ - "properties" - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/PolicyExemptionProperties", - "description": "Properties for the policy exemption." - }, - "systemData": { - "readOnly": true, - "type": "object", - "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information.", - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" - }, - "id": { - "readOnly": true, - "type": "string", - "description": "The ID of the policy exemption." - }, - "name": { - "readOnly": true, - "type": "string", - "description": "The name of the policy exemption." - }, - "type": { - "readOnly": true, - "type": "string", - "description": "The type of the resource (Microsoft.Authorization/policyExemptions)." - } - }, - "description": "The policy exemption.", - "x-ms-azure-resource": true - }, - "PolicyExemptionListResult": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/PolicyExemption" - }, - "description": "An array of policy exemptions." - }, - "nextLink": { - "readOnly": true, - "type": "string", - "description": "The URL to use for getting the next set of results." - } - }, - "description": "List of policy exemptions." - } - }, - "parameters": { - "PolicyExemptionNameParameter": { - "name": "policyExemptionName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the policy exemption.", - "x-ms-parameter-location": "method" - }, - "PolicyExemptionScopeParameter": { - "name": "scope", - "in": "path", - "required": true, - "type": "string", - "description": "The scope of the policy exemption. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', or resource (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true - }, - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The ID of the target subscription." - }, - "ResourceGroupNameParameter": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group containing the resource.", - "pattern": "^[-\\w\\._\\(\\)]+$", - "minLength": 1, - "maxLength": 90, - "x-ms-parameter-location": "method" - }, - "ManagementGroupIdParameter": { - "name": "managementGroupId", - "in": "path", - "required": true, - "type": "string", - "description": "The ID of the management group.", - "x-ms-parameter-location": "method" - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The API version to use for the operation.", - "x-ms-parameter-location": "client" - }, - "PolicyExemptionFilterParameter": { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "The filter to apply on the operation. Valid values for $filter are: 'atScope()', 'atExactScope()', 'excludeExpired()' or 'policyAssignmentId eq '{value}''. If $filter is not provided, no filtering is performed. If $filter is not provided, the unfiltered list includes all policy exemptions associated with the scope, including those that apply directly or apply from containing scopes. If $filter=atScope() is provided, the returned list only includes all policy exemptions that apply to the scope, which is everything in the unfiltered list except those applied to sub scopes contained within the given scope. If $filter=atExactScope() is provided, the returned list only includes all policy exemptions that at the given scope. If $filter=excludeExpired() is provided, the returned list only includes all policy exemptions that either haven't expired or didn't set expiration date. If $filter=policyAssignmentId eq '{value}' is provided. the returned list only includes all policy exemptions that are associated with the give policyAssignmentId.", - "x-ms-skip-url-encoding": true, - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/policyPricings.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/policyPricings.json deleted file mode 100644 index 5410e7c8f3ae..000000000000 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2021-07-01/policyPricings.json +++ /dev/null @@ -1,430 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "PolicyClient", - "version": "2021-07-01", - "description": "To enable policy Advanced tier feature, you can create the policy pricing at a subscription scope or a management group scope." - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/{scope}/providers/Microsoft.Authorization/policyPricings/{policyPricingName}": { - "delete": { - "tags": [ - "PolicyPricings" - ], - "operationId": "PolicyPricings_Delete", - "summary": "Deletes a policy pricing.", - "description": "This operation deletes a policy pricing, given its name and the scope it was created in. The scope of a policy pricing is the part of its ID preceding '/providers/Microsoft.Authorization/policyPricings/{policyPricingName}'.", - "x-ms-examples": { - "Delete a policy pricing": { - "$ref": "./examples/deletePolicyPricing.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/PolicyPricingScopeParameter" - }, - { - "$ref": "#/parameters/PolicyPricingNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted", - "headers": { - "Location": { - "type": "string", - "description": "URL to get status of this long-running operation." - }, - "Retry-After": { - "type": "string", - "description": "Number of seconds to wait before polling for status." - } - } - }, - "204": { - "description": "No Content - the policy pricing doesn't exist." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-long-running-operation": true - }, - "put": { - "tags": [ - "PolicyPricings" - ], - "operationId": "PolicyPricings_CreateOrUpdate", - "summary": "Creates or updates a policy pricing.", - "description": " This operation creates or updates a policy pricing with the given scope and name.", - "x-ms-examples": { - "Create or update a policy pricing": { - "$ref": "./examples/createOrUpdatePolicyPricing.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/PolicyPricingScopeParameter" - }, - { - "$ref": "#/parameters/PolicyPricingNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/PolicyPricing" - }, - "description": "Parameters for the policy pricing." - } - ], - "responses": { - "200": { - "description": "OK - Returns information about the updated policy pricing.", - "schema": { - "$ref": "#/definitions/PolicyPricing" - } - }, - "201": { - "description": "Created - Returns information about the new policy pricing.", - "schema": { - "$ref": "#/definitions/PolicyPricing" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-long-running-operation": true - }, - "get": { - "tags": [ - "PolicyPricings" - ], - "operationId": "PolicyPricings_Get", - "summary": "Retrieves a policy pricing.", - "description": "This operation retrieves a single policy pricing, given its name and the scope it was created at.", - "x-ms-examples": { - "Retrieve a policy pricing": { - "$ref": "./examples/getPolicyPricing.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/PolicyPricingScopeParameter" - }, - { - "$ref": "#/parameters/PolicyPricingNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK - Returns information about the policy pricing.", - "schema": { - "$ref": "#/definitions/PolicyPricing" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyPricings": { - "get": { - "tags": [ - "PolicyPricings" - ], - "operationId": "PolicyPricings_List", - "summary": "Retrieves all policy pricings that apply to a subscription.", - "description": "This operation retrieves the list of all policy pricings associated with the given subscription and the management group ancestors.", - "x-ms-examples": { - "List policy pricings that apply to a subscription": { - "$ref": "./examples/listPolicyPricingsForSubscription.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK - Returns an array of policy pricings.", - "schema": { - "$ref": "#/definitions/PolicyPricingListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/policyPricings": { - "get": { - "tags": [ - "PolicyPricings" - ], - "operationId": "PolicyPricings_ListForManagementGroup", - "summary": "Retrieves all policy pricings that apply to a management group.", - "description": "This operation retrieves the list of all policy pricings associated with the given subscription and the management group ancestors.", - "x-ms-examples": { - "List policy pricings that apply to a management group": { - "$ref": "./examples/listPolicyPricingsForManagementGroup.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ManagementGroupIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK - Returns an array of policy pricings.", - "schema": { - "$ref": "#/definitions/PolicyPricingListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - } - }, - "definitions": { - "CloudError": { - "x-ms-external": true, - "properties": { - "error": { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse" - } - }, - "description": "An error response from a policy operation." - }, - "PolicyPricingProperties": { - "type": "object", - "required": [ - "pricingTier" - ], - "properties": { - "pricingTier": { - "type": "string", - "description": "The policy pricing tier. Possible values are Advanced and Defender.", - "enum": [ - "Advanced", - "Defender" - ], - "x-ms-enum": { - "name": "pricingTier", - "modelAsString": true, - "values": [ - { - "value": "Advanced", - "description": "The pricing tier gives the user ability to use policy exemption feature." - }, - { - "value": "Defender", - "description": "The pricing tier gives the user ability to use policy exemption feature. This pricing tier is managed by Azure Security Center." - } - ] - } - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the policy pricing resource.", - "readOnly": true, - "enum": [ - "Accepted", - "Succeeded", - "Deleting" - ], - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": true, - "values": [ - { - "value": "Accepted", - "description": "When creating policy pricing at the management group level, the provisioning state will be accepted initially." - }, - { - "value": "Succeeded", - "description": "The policy pricing is provisioned." - }, - { - "value": "Deleting", - "description": "When deleting policy pricing at the management group level, the provisioning state will be deleting." - } - ] - } - } - }, - "description": "The policy pricing properties." - }, - "PolicyPricing": { - "type": "object", - "required": [ - "properties" - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/PolicyPricingProperties", - "description": "Properties for the policy pricing." - }, - "systemData": { - "readOnly": true, - "type": "object", - "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information.", - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" - }, - "id": { - "readOnly": true, - "type": "string", - "description": "The ID of the policy pricing." - }, - "name": { - "readOnly": true, - "type": "string", - "description": "The name of the policy pricing." - }, - "type": { - "readOnly": true, - "type": "string", - "description": "The type of the resource (Microsoft.Authorization/policyPricings)." - } - }, - "description": "The policy pricing.", - "x-ms-azure-resource": true - }, - "PolicyPricingListResult": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/PolicyPricing" - }, - "description": "An array of policy pricings." - }, - "nextLink": { - "readOnly": true, - "type": "string", - "description": "The URL to use for getting the next set of results." - } - }, - "description": "List of policy pricings." - } - }, - "parameters": { - "PolicyPricingNameParameter": { - "name": "policyPricingName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the policy pricing.", - "x-ms-parameter-location": "method" - }, - "PolicyPricingScopeParameter": { - "name": "scope", - "in": "path", - "required": true, - "type": "string", - "description": "The scope of the policy pricing. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroupId}') or subscription (format: '/subscriptions/{subscriptionId}')", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true - }, - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The ID of the target subscription." - }, - "ManagementGroupIdParameter": { - "name": "managementGroupId", - "in": "path", - "required": true, - "type": "string", - "description": "The ID of the management group.", - "x-ms-parameter-location": "method" - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The API version to use for the operation.", - "x-ms-parameter-location": "client" - } - } -} diff --git a/specification/resources/resource-manager/readme.go.md b/specification/resources/resource-manager/readme.go.md index 43a901b3c4af..82c8b1f71de4 100644 --- a/specification/resources/resource-manager/readme.go.md +++ b/specification/resources/resource-manager/readme.go.md @@ -35,7 +35,6 @@ batch: - tag: package-features-2021-07 - tag: package-locks-2016-09 - tag: package-locks-2015-01 - - tag: package-policy-2021-07 - tag: package-policy-2021-06 - tag: package-policy-2020-09 - tag: package-policy-2020-03 @@ -135,16 +134,6 @@ namespace: locks output-folder: $(go-sdk-folder)/services/resources/mgmt/2015-01-01/locks ``` -### Tag: package-policy-2021-07 and go - -These settings apply only when `--tag=package-policy-2021-07 --go` is specified on the command line. -Please also specify `--go-sdk-folder=`. - -``` yaml $(tag) == 'package-policy-2021-07' && $(go) -namespace: policy -output-folder: $(go-sdk-folder)/services/resources/mgmt/2021-07-01/policy -``` - ### Tag: package-policy-2021-06 and go These settings apply only when `--tag=package-policy-2021-06 --go` is specified on the command line. diff --git a/specification/resources/resource-manager/readme.java.md b/specification/resources/resource-manager/readme.java.md index e86a77ccec90..3028cce811ae 100644 --- a/specification/resources/resource-manager/readme.java.md +++ b/specification/resources/resource-manager/readme.java.md @@ -54,7 +54,6 @@ batch: - tag: package-features-2021-07 - tag: package-locks-2016-09 - tag: package-managedapplications-2019-07 - - tag: package-policy-2021-07 - tag: package-policy-2021-06 - tag: package-policy-2020-09 - tag: package-policy-2019-09 @@ -134,24 +133,6 @@ generate-interface: true fconfig: '{"moduleName": "ManagedApplications"}' ``` -### Tag: package-policy-2021-07 and java - -These settings apply only when `--tag=package-policy-2021-07 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-policy-2021-07' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.policy.v2021_07_01 - output-folder: $(azure-libraries-for-java-folder)/sdk/policy/mgmt-v2021_07_01 -regenerate-manager: true -generate-interface: true -fconfig: '{"moduleName": "Policy"}' -directive: - from: policyAssignments.json - where: $.definitions.PolicyAssignmentProperties.properties.scope - transform: $['x-ms-client-name'] = 'scopeProperty' -``` - ### Tag: package-policy-2021-06 and java These settings apply only when `--tag=package-policy-2021-06 --java` is specified on the command line. diff --git a/specification/resources/resource-manager/readme.md b/specification/resources/resource-manager/readme.md index 06e05d84ef9e..dc31314e2441 100644 --- a/specification/resources/resource-manager/readme.md +++ b/specification/resources/resource-manager/readme.md @@ -37,7 +37,7 @@ tag: package-locks-2020-05 ``` ``` yaml $(package-policy) -tag: package-policy-2021-07 +tag: package-policy-2021-06 ``` ``` yaml $(package-resources) @@ -64,24 +64,6 @@ tag: package-deploymentscripts-2020-10 tag: package-templatespecs-2021-05 ``` -### Tag: package-policy-2021-07 - -These settings apply only when `--tag=package-policy-2021-07` is specified on the command line. - -``` yaml $(tag) == 'package-policy-2021-07' -input-file: -- Microsoft.Authorization/stable/2020-09-01/dataPolicyManifests.json -- Microsoft.Authorization/stable/2021-06-01/policyAssignments.json -- Microsoft.Authorization/stable/2021-06-01/policyDefinitions.json -- Microsoft.Authorization/stable/2021-06-01/policySetDefinitions.json -- Microsoft.Authorization/stable/2021-07-01/policyExemptions.json -- Microsoft.Authorization/stable/2021-07-01/policyPricings.json - -# Needed when there is more than one input file -override-info: - title: PolicyClient -``` - ### Tag: package-policy-2021-06 These settings apply only when `--tag=package-policy-2021-06` is specified on the command line. @@ -688,10 +670,6 @@ directive: from: policyExemptions.json where: $.paths reason: policy exemption under an extension resource with Microsoft.Management - - suppress: UniqueResourcePaths - from: policyPricings.json - where: $.paths - reason: policy pricing under an extension resource with Microsoft.Management - suppress: OperationsAPIImplementation from: policyAssignments.json where: $.paths @@ -712,18 +690,10 @@ directive: from: policyExemptions.json where: $.paths reason: operation APIs for Microsoft.Authorization are to be defined in RBAC swagger - - suppress: OperationsAPIImplementation - from: policyPricings.json - where: $.paths - reason: operation APIs for Microsoft.Authorization are to be defined in RBAC swagger - suppress: BodyTopLevelProperties from: policyExemptions.json where: $.definitions.PolicyExemption.properties reason: Currently systemData is not allowed - - suppress: BodyTopLevelProperties - from: policyPricings.json - where: $.definitions.PolicyPricing.properties - reason: Currently systemData is not allowed - suppress: BodyTopLevelProperties from: resources.json where: $.definitions.ResourceGroup.properties diff --git a/specification/resources/resource-manager/readme.python.md b/specification/resources/resource-manager/readme.python.md index 111708603d2a..db2cdbd2033a 100644 --- a/specification/resources/resource-manager/readme.python.md +++ b/specification/resources/resource-manager/readme.python.md @@ -27,7 +27,6 @@ batch: - tag: package-locks-2015-01 - multiapiscript-locks: true - tag: package-managedapplications-2018-06 - - tag: package-policy-2021-07 - tag: package-policy-2021-06 - tag: package-policy-2020-09 - tag: package-policy-2019-09 @@ -200,16 +199,6 @@ namespace: azure.mgmt.resource.managedapplications output-folder: $(python-sdks-folder)/resources/azure-mgmt-resource/azure/mgmt/resource/managedapplications ``` -### Tag: package-policy-2021-07 and python - -These settings apply only when `--tag=package-policy-2021-07 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-policy-2021-07' -namespace: azure.mgmt.resource.policy.v2021_07_01 -output-folder: $(python-sdks-folder)/resources/azure-mgmt-resource/azure/mgmt/resource/policy/v2021_07_01 -``` - ### Tag: package-policy-2021-06 and python These settings apply only when `--tag=package-policy-2021-06 --python` is specified on the command line. From c24ee32fb97dfefbeb34df5f981af8470bdf6593 Mon Sep 17 00:00:00 2001 From: Yuchao Yan Date: Thu, 28 Oct 2021 10:40:48 +0800 Subject: [PATCH 06/19] Guidance and rules for release request (#16561) * 0.1.0 * update * format --- documentation/release-request/comments.png | Bin 0 -> 2257 bytes documentation/release-request/default-tag.png | Bin 0 -> 17295 bytes .../release-request/expected-release-date.png | Bin 0 -> 5244 bytes documentation/release-request/link.png | Bin 0 -> 3576 bytes .../rules-for-release-request.md | 46 ++++++++++++++++++ documentation/release-request/tag.png | Bin 0 -> 3605 bytes 6 files changed, 46 insertions(+) create mode 100644 documentation/release-request/comments.png create mode 100644 documentation/release-request/default-tag.png create mode 100644 documentation/release-request/expected-release-date.png create mode 100644 documentation/release-request/link.png create mode 100644 documentation/release-request/rules-for-release-request.md create mode 100644 documentation/release-request/tag.png diff --git a/documentation/release-request/comments.png b/documentation/release-request/comments.png new file mode 100644 index 0000000000000000000000000000000000000000..58a7a693cc4d0c0570195584afec817ca3b8f908 GIT binary patch literal 2257 zcmd6p`8OMg9>s$xtrYFEq_s5K(kitzTI$)UWm-~8EKRh=(kMj9Jn&GNCF)V|KX zU1y1YX?JNwIc3Sl-<*>_@0PT=4sr(w9~;;et01-PUM``N7{lC)?_>|1sI98nvIRV+ zcEC6y03$*w5Fq>Ez^{j9MBn@rF5>fm4A8Sg018xf0N0Ly0B8R9*ugK!J+S6`HLTxp*D1`-)&S1YuOOxZPpn4T_!*AN3ykZ>#Y|gc49onP zVp_DVS|v`0+~@V=s`}TP3tx65W)7Ez2ur$6e!S8O-1n#?X1SwVv#~ouybT52qE&!hVmC z`>_)0?0^1g0q~J+Fbt08&C(+is|C}eMn=_RAF>tsf=s1)4wd9?z@>^p^6T~alfHeG z@wIakPEyy@VH0vggQ9V!dRvJNGc(>c-^$3gh-)__BH~f)uIz&5hp-mC3aBm6 zKW@XD63+9U(7YEPxz+GV=jZc*1y`zO%P-`WkNmq1L(=9Cm0-$1s2Bi4u|`+Cr`T*tr=?5%}u!0va{}<^t-@aF-(bkhWS=zd28e zc?E=e;d!i^jyvvbGF*ZTJM~1s485a@Vgw>0sE$r#pm463$F-YbhQs+Fs}TKUu>ZI1 z+|k>R^CDJoF`8r;m7BSYirJ*PJ%( z=xDD>xq@k8Jm%heJHA8k@HG*xmsnkGU#N)Tqw*ejL6p0Y5f8GDPj*keLZ`T_vaINa zudqpyc-l_6TqJ}v0bJ^;xu6b8|AGJT%WMu=4sBU!aA1NJ^PCcWA-iMEj~T+N1Bbv% z7+)!gBO4d`;qH}8bD{R^yW5egT=l%GTVtG&x@O zb8NSZjRt?^bPe~Neb6NPgVPziTZqvVKF$rhh^4sV*j{=3zyzB6IaaYihWSRTNT4>FX_AVu++dhL&{JaOQe1Gl|m1r4eDsE z*h_)CC1G9!DJzegTwRpZA`%tQ(Nqn=JYF%)oHVZlUMdF5bM+7w(^-!%&gDmUS5Ixu-3I^T5O(^6Cmsiv=CRJsT2MDl#8h@sdG#t)O`W%iz~4X3m+h5vZU z#SG>T^J8OXFJ3G)u5Ve03tIZI@q4_3IA%Nf(OAM_80k~gIbsiqNUKcx8!(t()4Q?E zwS>jV;#uTS;XJ7IgtsQkCme7Dw0ymiGk)_6bfA-{sjD%0A5|_?GvKq3MdUa*dIco7 zscRJU2SLo}pAJl&{SPp63j^C&Tf0}C0`N(}90ft`?Ck#V5}pboe-f7dKdAjhucKRs u#WY6#U7SP~%*_qs%CQ6(Vg8HWcEG0suyXudR>1y90XST7vZ=T7dGIe6k0h@E literal 0 HcmV?d00001 diff --git a/documentation/release-request/default-tag.png b/documentation/release-request/default-tag.png new file mode 100644 index 0000000000000000000000000000000000000000..44a6c11f0c5e11e4fba7ac4d711a5e03423781dd GIT binary patch literal 17295 zcmd_SWl&r}*DeY{gHLdWA;BdCcL;+AC%8Kd?oRN*LlPvoySo#d;LhOg7J@U#oxJya z=g0kVtIn;u^_{A-|Mc{py?b`|bgy2|TF8CWI<{O2(LU45D?#? zqr%VF6jq5KAkZMlfh07%(oa{hH8l2f*q<4AtlFQ?RkrceAZ*sX))@3GDw;GD5_HyQ z5C#yod>O3*9VW93J{k6F=7@)&xs5Nb&D2)X3=iW42Z-JVtXsVOTFa4(l$UfDfmz=Bsml@lCiDI5U;HDw6B zqJKPqC9orV%TT5U&lXwHG1-y@50+(rL(5H*CUJ1fEjZ*ZRTy!;S%MJOIUZr12sge0 zFfV>k4amFd${`Y(o~JV&lq-*_VMwS{pD?je?R83a(@@wIcnfSjt!DDzMwcHb9qW=l znl&udA1KMDA`UO!AVi;xHrD#!*MIrh+9Qf}mUK$@g0)s5m116wJkP~%lH_Z=#($oV zlDGds!2KiD@Gzziu6tgL61i!Y^CiYOf0&?L|5~qgr^)lGR|9H9l+KJfetsA`9j@LD zMYmAV^A}d!vI~kgfYktPv;DzOPm}X+Khjm%v{;C1xw4h6iv;Z@O-$X@P#sOmTA%+6 zh2)dULQ;86cdt_)y;_%4PaQJ${IxS$9aAv4hgp396Gb*`e7eF_gRZh5w`G&+ORXa; zf?dIIL9+#v6P*UCM5U*FEJ{V|9|1>YPS#!u0!~exAtw1F;vi5y9+pP{bHn>p6Q`h> z>-Y2J(Ad2MmN)QubT1GWbuDv52=!*|r8vbmGEDY$+WbS3*3GJB)i z&=m7tA1pJ|^3umrz%$wAYd21!);uF(%_`xEo#sjY93Q7JSPhmD zAj8h2I*)X3%e>h?OUX@0{T^BGr9=8@Y_3SPv4+GduW>u$k-u2Pjsd)mk{_n$0Qr;7 z+EZ6%Zdbx8e&VHkTmd?4ant5AYpw?<@9;rfFF(}o+l)0-F4(H1(5Gc_Fyh#Z%;ZF; z1{)`Xr-GwpZcQg@P<8AJ)k%dDlE;=^8Ldr;&2*N8`=rCgxyGL(d%V=+D+_T|yo-?& zW6!d_)I}))#nzV4>QM-}vbw394U)=#OWE3`Kri)@>PHG@{pcsEwZ7AMxxUL?l*ur` z*meyYJV93!!?^Tdt)vQ>Yn8@2X$V5Q0kZMF^Ea*f52A+u z__Yso%3A!)Qm)=I)hPHw`t{RKK zz(tQzW@<@ys{dM(nCe{UhZO6;NSZ5NfwOKUjs(aS5ob*d1zf8Q`vl@9;Afu4eHS_` z9h-|!omosdc{AI3$~fkZ;Vw-V!^bApWIi$|WBR*sA%SoT#w$tGVU6S76f@~rFBv#< z(EL#an6xvn=omN^Hy^L}NzCAHK5*`jPEu2V9}4A~=5DciwM8Ac*p;6?k;rC51i3iJ zZ9$kd(o>1&FAV9#;)B~#d{-}LkIj~=>JJkUapz3Y+VXv;SJ(%&8DbZgIz_lBv7mYI zvcboUQ;M}89G_{uEZOCw)h1zgc08sFmZ_2%sy{07@Wa#Mz{Q2^;vV5H(%$%hd;EFm zea@u#eOe~s>NOHH#RgBB;)GK&exQT=B2BW^QnX~zP8~5xr%W3}BmZ=ZMWL&6meVL3 zJNesGA@&{PsEBEqccg3}w$$QOBj58zv3E+GuIr`QuC%#UYO)Y_;MyZHTAkr99co;# zW&n<<#o}+MW*8-hU7hkMt5D%4jz_5zTd)a8#+?&Gp>%R{?=4x?{MO|7`j$$D*|#}} ztG1<31T*LnjH<%UQ^9MjyvDVcNRg^7-7oZ{{Oxwpspt_S}1 zx0;RvWj;zr(GOK~P%G!)TTw+gWIvq$2LHImXAouNQYQA$J5aonz0ZYhXHW_R3W?6W-93QuQQug zd`kKhshN<*{pinUh=L~tIuoHRtyz*RU`+>+OFdkkfUT4@aCfy#TN-xp%I2Xk=E7CS zl{#2vP^(wPbd_#$xYqgjXDk&=lB`sLqNng-5SM0nI~?1(RCKGbu!%^~XebWsNAo}? zF9`y5nyHs}krP9V53!q#L=Lv`SRE_deF|>rCyqSac0qKrZjva9+T8i{;##O~P0buC zgJUKsiDyMYwE>112gS!0Sq377#(d>tHI!M|J<)UA>i7v)2NM7?L6jwN9_}1km3UP- zoq&UT7aS?5-E$AZDrkg`oAzs~F>kAZmfcA2(DGSYZ@@eF=m^2hb#aM$e7zGGh#BOO z;3dgM?q&QT;L_rpg{0H9cvUU_*aG3pI*BoLAFc7hbN&Ks?sW?^L5O-Yz|{vP8nONx z4GP)$or4PkJx40m1ROkd`LkncGlSmlX2(mE8mh(~=c#Im%;$*qXH(0bcW&l>vwU+g zy54yw+KEt*W}c&z+El4P#<>#OdbC|EtRF0S-TP!fVO#8btjrXXm^GLtk{%HU8B*qi z-seSKT7TkG_V>#{!KGKa%bM7YSjjQi->pE8VMQ|{^PZMV2mG`~p zCWqdiPo(V`e)9B{*`VQxFRih&$$g^moXdXCL#muF7Iso@WU|_5dcrL7syD^Ny7IA9 z=4O)?&m{iFBdG`P!tCBSQE3+2;5XbwLLfPLoOV7D+=L#A@s}VJgk5gx9UBO(IVQ|i zAorW-#1%Q0CTR0`rgjXBLxXWU4jFmh94${-wB>xn#-8Zv40){K=vIpTl@dTu@PMIfA5rC+%2MET+3m5#`DQ=5=Jj0v8R{$^AVF+n z<8{|usK`VI!W_$Tg5YN&mi#IUd0mr-i~P?4dG>rBn$HwM)AdPCxe^+CV6T0fMLwls zjhl03!WaV{#%1nm$2JmOY^ZlO5$^6HgW)`=;@3zbX|?9B64rIkQb+p;<`q|0yTRrC zDM1Fxd2gT3o0t6_Y7|Xo+`pXEv9G^?Pi?1s<`{blEm92uvYwd`$-&P^G1H9Zs!C%d zbXPuf+^L4S<_dgRlS>T2nYX^_pK1x3Pf7MFuN=14>!jYvGEdYgUX^1gN(4w@%tJe+ zK*Agpaf@H}Lb@pLJc;lDQ(sMDGsL*KjkV^11fLs!IhCEy*{9FjvwNe0htnvUXv12Z zlc>Fm!DSz(qGCk@@%x;(G`ha@U=#@)4M5}NOds#wW5nNF5b70fEH8V2QUv@E6hl5V zq$9!tJ+W{IYkQQstsqTYXgLQFFYm7a=?_6)= zPR>~pRcrycrgcRbX7C1(@H!-8eP-M4g3Al|gmO|+&f~9KJazAH^suJoFOE3ID#8+@mULn=rSX6Dj$jkTC`S_hcJJ~@nrj@s&_jXl& zf9t7Z!X)8J>arWrpEobH$(3Skx~0KkkXyImbz)kQsk@G6Rs3zmWLv_MK4?AdkN^J{) zt6R7K#oY1KQZY!?g8%LR>@l}Wx zwxz`jl?B**#!c2p>E*2R*?*TE0GMLzK2);)p(ep4fMesmWfcpM&OP2Qir|vV6K$1iT8ah;%vFtA{~wLnMZNp?Bj~6?@B$cSTn&HH z|0An^4Zaeoa_U-3w^DEmdv!!Yq+^9-S`oO1`-nF-3eAz@0bQPR#s&}4v$1YJA0)p2 zi0&C(grIAt5tF1jS&vs$2bxFk1`@cy?{pxB@3l;%dd!%3LTkONeAfro!eJr(ZE&zz zO@sx(;OhFV5ZwFc>z(7D^@H6(M{$EG{c<55FTMDodnAv1o1AYP8YL8t-xsU(9f3eH zR=X(5*Z~_nvaGmANtv%z>bU2f%9%3T*q2q|1DC~AYaO`hJ}9;76*=RO%7<;JdNXz+ zwP(Cjx3sJZ#k5OP-qjyDiq#({J}=f?YjAK(3ioS8M9AVZWFmHxnEAT$2j z^Oscair%Ez3zT93E#rWpf>Lte<(LYYHCKt80E}oJ8O?20IlLVqm2|VLac7 zDT~QxKgPXbc08tkqRmCUsiq^wF5@yU8sU<1qk~n>JOok$L0Y_5i)Fyq=U*LLq}lU4 z`)hczm?fUaF>lQ3{%*ETFbhULdJR7RbeM=BUhq{JpKHKs|B)6~9BJ#?((ir1?}`9! zr1ZShhc8=Yk`rm#1_xAN1)XJEs#Bq1fFls&)^5O!?|WRyKm-l20Rb)0hl8ksITXqkS@$j7rpGrXLQFGfRO9*gS6-o03dyJ$=XrMS7XCA0F%pJnt^O-GpT4Eni zd4vaITa2SDwMsCU-Z>`X^dCD<5aSqi|5475s%Xuv#z!G#=f_#g_qipUrR;)bEJw*A zusoU**LWoJ9+GIpl8CywMV5#fD|ORP$~YG7nl7e9q1P8Y1{K)T(l%rjYkbzf4I;~T zb$_w^vHMO?)T+-LeQr0`tsO9O>Fdo300s--%+iE)agSr!+IY5lW%X;C<*^ibiCt=qG@|@sk>m3d(GAnnp3^4QpfF_7b6aa$_5t&W73L20eq2%3zd= z)d^^O)201hiX`AZ8U>PS9q^T26wLy+G^dkkPBba6);H<|+Q*~tW>C{kfERzg61F?t zpzUjCm$jd_@E3QuMUB?h5U7Ewde$V>ave1Jq$g;p_*rjUQZPxevZu09G#ZXa;G>CB zFDvAUXrrVMs|9wp9+alAb*mhi-0pqRkFSWxNIg2r3bNgT2fh;4-t(Zx6FcrDk2==3 z!g^U*NL89{wV-AhGr4(`W7nVgcRmYjS3lVJo__1BBw6&XwXA=@EM~m6l@$H@an-q8 zM>EE9<`mPb>p`L2j~`8S+N88-V^cu9Kts~20ws1jJ+MX^)*EY-Thl4g*l~XsFO|@k zJ*`Vyb%DQJ31v$|Qbv{mRGKO*wEbLAjQ!)}%qu1uC!%+g+uEz{|DAumf5O$|fKooKD3c7zcdy#39pyR*sjoHWK&49Ok+3!}*7eju=Q%=u3rV?ioOgax_bVCmca z#wJt^{;n21jYjvS04?yz)0l2+1-J~*@P2_J%8!r>4bYvm?l_yv?a2QiO*-W^O?JeJ zCG*E5f~UL~Q0#vBUU^UWRmC;5DpNWk&2nY$TSv2927#b#bUq30@=; zOCV_Eys8^Uz351urfjzVZgDl--?|oi`?DlI^Lonpg1-)L;k0XoF{Hv_N)Dz(|vgJ+6aNZX3Vi*C(Y z9POkgl4WSkV6S|Lplm+JQ`gxOPw{>fJO+;qJ|TFA^cs-FH%;CEedjKlyjteLw;PUx zBv|TcmT@Q1XWHH_fTpTOEUHM6IfO8N^LI>*(&(^X&l6JOK(8%?lw(cezJ6qUa6&YQ zH$TYPNBehh{t_B{6Wyx|!bSC2_2=`MAOs}T)(kjks7WRhSsl-Wldm4MDbc^tsWI`d zw3zWjo@O7v7XwJQh3 zQeo@Ly_>!6)Lf0{?&SpD@ZpmdgZmX7;-OXJ{mjd!2-f)USg^U{maT~UuMgVY2zd<( zGk4akOvB<6H7s}QM>bv`xR7e_SI=p|6LN1!Ci4EC&RCy5Qkz83qAqvdq2Q;4da@uS^1mu*0d`U6aQjCW+VBEVuSn5P^9l^(~BXP>GLDEQ2RmING2a?ZPkE8-wV2hyNg-dQq^#(9Y`Z&p3%o zv~qb2P85wXq~F>%UuN9Mo3N}!>v6(D?y$*_W+sl=1#S>^lciJl2h_u8m_;V8^ttp~ zcLMx>PW>C=AF+xxc~go=t{33*N*^rSs@D8=r_Ll*>DYYDx@1oEWwTmD;b+L2=t zNz(AXKp4T;@^!t^t&D~cknR+@*M3a%**-huL%fr-^pv{?Z`pzQ%W&oRuW?)FXBJ+w z`L91>tpBVCOry}qOk*ksw714L=&EpDlAe$zy#X*yylBKy9s<4CJR}iowzrD{*V^*{c3{cr}i*5D+q}g1yj*N>kB{s-wzG!fxM(f6sHK^)1*t zb>5;Tr|dQH%cZARLGABOr*V(=@6>2ljUs>l#R?0rw>ULCP@oQI(gns3=1Bj+3-*V} zcTR6Hiuf-RjGnoHqA5T=;+IU-76CYGM#?!$ykwi2F){%=6$r`QK`|2qF>dvc3$waH%1x_go*nGl6;h;%Ng;fT%s0>KKWK?NG10i z*F8Srrg7d|X$w2mk*brbK9)WnHx=`C{`?K^!n82xAv%E_4ZAONk_lbYv$aJgWHKvU z+}|D=%?+WKp!>Yx=_h(3F?;DvN&B5E0WaqxxZlui;g28zolOf_qDAIJTxSDGo4h$DP&4X=kK{1;nz(1<(a6ie zb|MKC1;nb>6LkINQ@?dh;eR87Q>jhu@gNJQHUKYD!<^b-^rYg1ih z49*rrPT-XMtVD)WUZalgu7PSetSDnwe6PG%>?q-WQ3rLOI>guOGbN~eLZQN$6XzMI z2MV%3F?bMAN!0l@T#aehG2-NqjkHB+SKULU%h~P!cJMZf6?{snLy!+1(6KVfPDy@$=drv<|17VhMtiM%V($i2R z;ik^=`W0*&JHxtsB|Hwg@RjV$AWL3RjU9u_icbFs_pSYQ5+EGR#;;yG-_X9-Vft{C zoFKyRrrY-N;UP{}qrIJqa4havip?8PMkFXot*hJ~#UsRVRW<<1_!^x{;jM#x(ArF_ zfEmB6b#$Dr`|y%d6+>jR-^Y^}KsXVfTeY_cD~(eoUf^530)wT1wFSBu>SB3#5y$qv zm18VHv|_|IaB!=4v#ehOxc4Qei05G>EyMVbKmaf`JWpa=FF`7%$cp@Y;pE3&f?s0` z#`#tlRdA$gY>#`ulQiq?gtB!Da`KxKmSnY8n0bbR1Ftg*f+=ulyT`u z*BZPo=rXx@oU$?T(S?Aas-6f!e>1W!l_t1SV6NT)hOPJ!yB8+!d4EJaDE=20AbI<% z7i4pm@W6^5NXvx$7ex3>so~#;Jqj_W@8E;}>0v-gBd^v?P#pQe-3CSYzN!Zjb zdGpFH1T?gb1j;|3;&F)X$K~y!;^7I9*IDiv51!R%*VnFG0rST1L_ApIkt=z#AGC#H z(7*7C;&g9e&ku~)d;hrn@K?Rzef?bS!zYHA?H;@|f>`JY8{@24P>=fGM5F|jKbUUM zHX@n)Z+%@U#Ysi|ZuvC=F(rF~t&5l0vs-KQSWhLuBa<0g@qOE#cKGqsbRC?UIW-C= zEbx%U;WEIxtO;$Hmo|7fj+;$`@6_VGJst0xk~AEk*Roo9nFni_?cVWFJO=2vV7vJH zaCt`1A?{ls_|k*qgW(tZYXOwI_)-4iN}kP=8s$D64Dp?G^H2`PUpU)bL+tLC154z9 zdQSA>^N#YSxoUsYAB-t@FO;M zal19UnU=p%7(VSy!zntYCyEs_x!uGFI^?X2I z(t|^PwhWP(5wMV0EXPPbcaEhHnv0k5C((~IM8;xEIB~p75R>6qC?7OFG-A0iY8Jzt z2{C>qw>{y0$)JA={3s{`dsQQij5qjYck_HmhhzUUySXaq-;h@4n?7flD^L{e9$aaB zh;tml#p5OgcTL&{^vBhcx~_jtZF%3LA@6WVPZe}lM!vT~q{8@++wf4`vXZQneXk2F z92AXZv;*b&8B|p%3f*LZgW2ic)L`~jgCicjDZ=Yh-aEUHI}J#>7A{nMuY&Af@ayOd zgwe>C6W17X4F@-wcn2hIH;{-S-D3)=c9^i^@c0n>S&iXO0P^l8y=U74GTz+{u*VKm zDq{N!FEQgp>Lwh-C|V2b?@A7Fa6*~7K^LzyE?AS2phlmBqT+!pwy9p~c%F$0BRyZQ zk5RT_)%*ngmHY%7I=0TGwj1-jM0rul%!XCpuH7X)g7dw~2#+m9A`Ipi5;JVAgUjPD z0`#a>k3eRJW!fxd8O!U>WO0@<+d26J8ybmr7T6lp9bXzEb~sd!SR@UkIFG8|By1_F z&w1mtd9;!Wa}Mp#iHvN2_L&t3s}g}HxJRNx24*BH=&Sl{0pC79=(YoK&3jmqz7VuM zO7&@05f9qEd-chj&rr@+x-ozgI8V_%?(M8yD@ZmcHGgR@J`#C-H-@8g`f<#YzgY-n zvj#Jpo$aP%-l3IU7nuy{NIpvSq!Z&meK2gBJ z!gAa>EqcF6xsEBW6imz)8_hKraIcN3V$*t%l9*+Nfm1;kM>*!X_^N~zI+h+00Se}t zO{DSte&Wp**VF`N35>H%kCRw>xuRKkQV1;CqiH}`92u!uqW#ef6LQI`Xu7m5kS>-M zUQZgzbWGX@IgNe_aNoB*|A?+#*fV=jb5`O=yfvhvbsy(0 zmU6NYwq5y1*JEKP89J!++5w_`iIbOtRor|P z>2q zZT~H)T*6ipxB+@D>@&HfELYjFtdGw=Ze#n^u7$g`&d5R^%iu@Elfr)S0fBD6D>sn0 zcULsID-ZF2fB(u4EE+RVw)Ns{`>C2$enzf}HltblNP}greWAY6c8i;1FKk5oo2wIm ztSoKvU8V#sTMCCBU;kx8OC#CKGx$8BMITZ^0K+I8o4z|GmF!t6vTrpspsh3lZC) zXiBT8)YI|6lGDBT?a>YPvQlD5<)G@#siiBfi(|hs(aVffj%-EIPUS|*xkUzY%i5_H z{C%&b(S%N`6pdPdDlBCd3CEb6m2#7aBC0ND75lOd7Xxs z!8Tq%JV=*O6dCl@Qto@EP%6S9haht66LGd{8zrnYvp8AI^kHLK_n7-t2{Zl zwIggG4OO4-DL33+-l6@MS39JoL8qbv)K*MqL*wH20s{*U_Yq zC}ln#%0fY&4D7=ON@QteWqD#$4M*LWXf(BIJ9oi1xm#b8h$ChhaLg2wT*aDmcJ9xM zjoMFMBGXR2x>^y>vNrw4ev^h&%Rij&Hy&)8iAlF^P#g!ZfuY18mE^0&1a`j)bRV5?i2ERUd9)rgFK3oG%JeP_` z+!*pnusoVDJG!q-bMC7+YQROuMSOg?;s*CV7j&_WtiQ(F%|A`B|0+KscADR}7x;O} z?FO6`xNQp(Bvw6?bQhL1&)$8nYm2~81PRQbrbfNy=ZklqwzXZt0zva^v&XL4Oy)s0 zD#7TJI8TqW=syJIvs`oo|4snt=e+cvR#w(!GlDb#M=|z;HI_OxtfBeF3V|URk%*LY z{n{)6`GD>h)#g{KHeJ&5K~~j+MwRx|vtpUyDjF^A_h@n7*Q{gNkI4l~tHH5%3DR{A zOEDH(zdHqs^h0%wB*mLbP*tzD(Li_tTe@5YjkAorfxxl~a#GZb$8dgXkwE4f8@IwS za~n`AKhZJ*gOv%yfac@e=%>&m!f3F`*XMk{cHRcYvg5uh?zB_H5}|vL6kSB0G^6A(sFh zJo8Wu#Hd*4OAETwXl2g5{d}4M9lNqJl*%YM|Ag?-ZzV}jtbtoqU*!CcDRBZ@hpe|v zw#8RfG^N9r5H#I5*FdSZ?x$^@!xq^T=qQF*9hC<;%EtYA_^Gn}Ci;enx>G zd*iG0duf64D(R&o(ycLR+Z#bkLju>T66*AeGGz+eq*{Y?uRzSv#c>qAyuDr%2ib39c4}vj@i6{0ToL!;$6KpTkVNX3Kp`D?6lgVXwp! z4K1SP6roO2swAfEf}Sd8xUqfAOAyrY>Em3lj19YYl#LzwiBjn3`2KP1GW&Izs1d_5 zPTFu`R7ym${_}gfgodG&m+JeNraaAzeiQF<=*$>PF}qu!gGb_QYLC73?5lGlJ)2px z*j4*HBB5bh04)#VsbFMr>t&%04~-&EP6n#IlaTz(eA+{6zP-N;awxri=UYX4#7l1K z?*)7tu1Ul~=S{owZCaBFl~M=oAy9$mc7NvR3z5R{9sjsjlrbMtv>$+q8FZpH@lw%( zSct?~l2avy)Z9b6{BZ^hdpR2E@v{qSK{vU(ezNNEp`Lk??W&=-gl9`pHF>6F9{K&7 z_ZZHn>>0_5o^MdED~L4gRt_}k%t8ZJ?AraTF~&1Fl?C3A36ZPfe|`^7Hrlkjb4d%f z0_K{!s%UbL2@^(N`Qdqg3`BbJsSDt5!n(h`&91COG*HVbznJ;@HcT0CwO(@jly2C` z>@O5dgv+rW^BMO>oP0K9j@%=yafbGlsa>-d(#nr$#$E#CwL3x#1(>Qe+9}li&#O0o z@d0U`1QxINPt|ApP_q?Ec`{h_M4sVWreaXe8PbTe>=@K}PXfj9_FS=}wi+2Xd7qZ| z^wx`^kcfD9CIh)7yQ?1ieisSsdF^M|VZ{ieWZpKC(Y2$B(;V%E5sy_dkx+*h4>7$r zOkWmbm^p7V_}ogAA8woQ$Bn{+aNcxc3RCv)&60M*X@CD70c)fj zcdSa+$_RW;bQ&@AU+y$T0GMLsCw$Rl_6>hYExIw}Y!@W7k$0q>^=Hhw2@|}%W_U!P zQjX`ZY@NSH$Ic4cz37k2bA*A%Ehz~1wVp0a%&kt(I$BbtkwaGP`&6D@)yD40+0kvO zk7jK+kScz+;ML6Pu^91TQ#_ST#gEj%WNkp?ySA=i9~ieEwCAx~a~NS`g8T?iq2Gv+ zO~oxylU~;hGbr=PE|b0e0L8AxqUV9?!UJ0Zzaf*6E-SV&?qZ!XR@u7;jQ*(LPEKVv zTM_DM*4arar)BrCkFBJ`NH{y z<4uZv%g*E8F3a0@V~ujqgtTC%ks8ugGL?itvdu8>j`7|-xnr5EY?cpXHG(77a54#H z?5=4S%no+Fn@%Qg*q;MyGX9MexrJ@GQn_x`f#z$-CbP4L1$qnN<8u}z8+lMQ_Ef4E z{F}BXmsGLKb+qj4eJ-f)^~Yjoq*ro;uwFlnzQ-9utpZ=h$o^Lj<#A0{7v%}oXYJ&v z5R0&%vi|RJ1V^6pKg?1tMOXO3_?+u|*@ZK;jJQoETseNxDCSde1S$e1#^x`J{i>29 z3dg_L=r*hcM{A5DQD+N$j)oMYq`d2S)G?}z^=B!D2cmRAZ#5|QeJQz3cE^tMx#b06 zElR>KC-Bs}tn?95QiojNI`FDfZSm#YTv0IvC`v&x1dgS5Ht zyswjT1@L}TWL~Vq`+^q%&61z{l#$+%1%Xc)$^@ftg547#+}|a%W|+K0UW>#QL()G9 zvtIk!K4njg--1ArLH;KYX=r&5-OzIh;whWfB(36|5Ia2RHieF>)(zJnd>BVQ53CK0 z_p~gXx>zKv*G2_}4)oE=Kg@eb;@@ z5}c>{?=w7%Tiy7t=MT|LJrmWA|3oU+#Q#m=l>bLw;XhiHTnY8B!6$>~C_bsqJ5ya7 z533d0=(lHz|%+qJ3742j@o82!!`cVcyNLXT?Ehn&E9hUpG3Ac z=a=;tid1YpSeA~!tt8hfZaeu*6w`HNik*&M$1_Qsx#w+X#RNz8)$e$FK8CKu$U&N< zCpP^?LtOSQ9};ZGVK~qG;Ff4(69M*S@agCILVzDu(R=b}vvQUIreU2hUXGD%HuV+; z@8%hwPF9#LY}>H?SVf4RFh26qBe~(R>rspK`C57M?~x6Sx<|~}@Sgj<*2eXB%nNnD zsBPC5N()iy9I2Z&Mne*Iy~(KWb=18!%cm7yH&?)oQ<#&BDV^rP)1*xYq1RDGa`w}p zYW<@fAa^i&M!k*Dk!G;{tVkvy?MW?A0nS%L`bE~Z{3~?Y4M6b($T!cO-p z`dHl#as0$koxhu!?fB_J;S)sX%OFO2(>oOL#l~0o2~YDHgBeP1MyQ@pWy+7QkT*6* z1N)H|nZK{6VxPb{hfmL+U<4yX%1=dhdb#Q6zZ>82bT6G9zj)jFP8;I5;w2`Ikp=V3 zr`~YhOB8Lhp%d@_RnYf9@7_uYw8tqdv~OREIo@h#WyijH^215m34z|JAh}qrTiq{4 zg_Cclz~&{aGc+^m|EQNg>fn2fEU>KFinTUNP0p@FtTwCzH>?D_m=7j~{M!hd&jUA0 zc5;|R;gdG5Tj`>3YcmBwzeivtK z2Ah7}(R^|-)GGD%bz#zFJ$CnJdv1d<+#q;uBc-!8Jc?3Tdq+38!Dnl12*Z!FWY6gL zb0JBXN@FFC0ij8w=+=s~!#+m1l?}sMM+5GMmA~4g@a{<#6qnz0?_7LRXZxN<^$Aa+ z=u~lkwniQ8#oX5SJNlc%AB{N`vpcVJiIDb?0^5 z3zg#OSL+Ke++m^>yB7vLTVh64uK@sTW>lf0H1%qiQ=@s@d6j*(2!B0GnfrxJcfpK|LB`?MtKAqiswP_(Pq8;Wq?(4ZGdIW35oE$R_-yWv0 zC!QlA*48ylnulwTx}gvR_0w-i@V@M^x1zIU!Ik zHTZ@~GwN}IpF|q;T4bzwML}_Drzw9b{VyUS^|p(D{4yerC>Ku=>QJisSc7}z({Q>h zkAM7n^zn5A`_m$7Y=IrSiMEpM@EIp=oEOQ?%7q#EP6t!W1?%33O| zsCgYnT8vVv{O8slF_qpu_n8RU2MULe#Irk*X4sIKu*A+cP{pgy6cD7GsOQK=m>8_D z60oc#p32@CVZT@bfuzyHN$D8-^wp zu|4fO_sX(-$>o7XTU4Wa$DT;HS^lLvuzu;Kc zV@mc$QJ2C=k0d7!#E)t|y9%O^Snqh6Uya#>3|3;{Gvmh=UC~=%n~iBA4SK58CPr1q z8{x2OFhrpzhJG5dUa|ks%(?iQitg^(gyM-WF>NqZ=iLWR?n{C4UDVb=77k>H^WW@&} zvnVtPo=j=B2`sm-o$1mDRsodX!E`+ov|$g$7J;{$J4LxCMeF@`i@HmSv5cY_NRN4Q z3zT?(RbIH8La_O+T~yC7qyg7)7J|Sn`o_62`(4j^kJHs`5)?dVo3s_X6hHqTaOBjDKUeD1#($lPT z(z4BynW{{=&wO!vd4+pbDS!n(UeRTB;rhXh|J$m)(bs#SN1JE=UsjIW>(BmK$4C$6 zmA|K+%~;mNasKUPwJVBT8Ll%qMTNrqd&A1{KrJFh{h@hJy9a#Q!z+#PK z9k_Ee*G^J}@pVg>+}i~ZT6yzY`Iux+US`CE3?{5Ey4Q0?(_Nl2}`({uH<0D24W5zVx{R zP=f6e<$_Z17@uM7bDe8x)Hww*p}*SBJyv(t0tdUs=C11+l?HOQJJaZ;OAaS#kxwO0 z#X1R(k$>BcjE;R(vrp+251Jlai4bHehNz%1A-5v4s)jRAf|2yb`Emwzh3Glw;v&_r zHx)7$02Zm_w~~I(jedGb+u!+oZz9kOl>2{zd+cakwnT7l9fhB|ve)pz~OyUt_m zX_JF~GV?BdnAr!>##!hpu06u!&Dx-(7Q6S@*Zk{LblJ@tdTIXn@%nFy>er((Dg1mz6kuC=>T*>fS&`gg zc^-iSZl)ZwHKmfJJylq9tk^x$s;xz0u#yo#t~o1nXtW@c1vp?VI6`k4a1D&on!tkR z{LH~AkL|-?lnj}+)c7$&@IBKNUw%B+ZRE8m4^P|vaQxu_52`Q_Nc|p~@blfQz}5FU z-nwDGOZRwmkK3)9hfm8N4mo?p!lF7Nrznm(-Dmn1ClnQULU|;BD{MUjidjDC7=5(b zI;r-jqd^wa{?RI|Jf6D4E7fBSnj>j8Lb|*l+J&+nJ=k^2Vloq+Sa8elc}sgtg4CO#$XO^3=U&k!t*Y zuO}?eUC|Bq{!B+jXWCxAU9{Ot$n4-ze$Xuxm1{7AuNX^FfsyAw@vb_lw}hz~H`FG!&mx1*?jVq;F?HK=f0|KRDxn!?2m%6<=)d;@ zXfTNJ&z-I=be#ZRP>p*y*x+Fdcl?!d--V8#wNrI6Lf=}lz=zeS&V}ow0-MRTb%oLk zz{~0r{<5F_St?tFx(9MfaH?I6#h*|iHMYgy%0Y6NV(!|56t=8L$mJF;DI`$&#yCBy z;aTN6g#!ACHTu_$XB>l~3+V+MnNNQ5<%l)O#=5#DnM-eB*(dG$DYq|4jv=DDypN0A z4Zrmlg}v((#$e|>!uWuM=>I9KUpy>QqH3)oaD5Gqo5|o;GMf$=sp175EJS{34scE7KcNImPT2}~lMiGrr8P2JWrD$yAlbg7LRqI%Di9rLk2lBNpVgqC#J zoxz@3Zem@@LH-$k`y{i(@QWN{oz}80@7<_lRue~-9i#t*r-2V9ACGO0NIZ{k;;#}- z9|gsLWT$ZI=;&9}wxGY<7QpT_M?Q|^crv&%Kqd?q*{m&Vhtb{2ei7ucSw3q}H2pNK zWoj=~%`NxW#zqkDC%F=xS|psj2}m=2iZSBrf5SwQW*YfV)1UzNB>qX`|KB`{^s_!( zxx7obJ%IT28}D23ufF;Z!i6^hKlT3=^*@f@t_OMt9*{AFn@ej&MNJ#f99XmT6 z6!2t3lI`EgDOMU6N^O?!#G|d69qIRzmJHpgu-jyp(Lx6iU)>pH>i*I;giAeRwzm-> z>0F93B9Cz%c}QXguYs3wzucG&>b-o;*_^a{bFU||x8G-2j(*=K>nL4A;mu-eSiBMl z1oFLlUHVcH1d@2nEP;T-B}APc001twBYZqOW1Tl3il?jhoL!gZTx&OelLLB!DJLy1>2q!y-ULKecZR8wB;!&#S<>EF*J+>A_gpF0Ft{eDKAJM^}q4zaLUsTL(k$-;1 zB0`t@ctAz8lCYW4OZkznJr3JvyO6Zre3dDcoI)GhprE8*8{o!S?y>JvG)tD4lRfr^ z{-BF75Jf1LZy~;#5q{|7PWEm?C?X#C6gzwRSm^bQW$P~}_Wes1&HO_k1|4vCU-oai zwy6JFNMp(AC&};aADL7l&sVksvcpgZOKjq2l~(;r`*fk7C=upo>tX_~mnvVywa$s7 zdA80r7v4Y7reLcxC~Z(mUHv%SjgEFUhNa2~g6A7lW_RAU8ce%CF!6&)ro5il>gUmU zp`gG*ubN2sUdEp5cUN0?3wxfu&G0`JO zZ*Q~8mYXa6zuJ^hGpG>^jLS;)jM%d|a9+xK@*+d{nWI-z71v6rh>+^%3(^87MBr=t z592n;!u1g*lJZ5Lm)1pno_-q05Nk(N6O=%ApGwb+ziE}Yv}pE050RGsnz2<{O|Xe6 zK$f~)n|K&GmFZD%rxb?hUJ{Hm+d7Wv0tN#W9n&|RexD>!?;u_5&Q1=l&us-b+q&)1mcIhreEcwceJc;b_UUax!JYm$*M?dn`bUl7n4I`9IJ~b0#=x zTXmZ8pv2lH@8r90-{nzupkEmK#tLadEI$(o{PzSYhjs0pXK-;2V6SdpkA_~;-ebZX zoOjX%?C5JR&N^YbT0-Fkcfw7AGTNb>jM=4USFMI+@maDFI4SVb!H-AtXHt!)l@a9H zF~0fHxH9=V?QxWM?KYQ7ZnF)91<6X0LJQ&SAk>*uE0!2a9UwDOeY3b{lq=-l`p+5} ztFw-)$KkiDAZQN58Z*mc1^UBPzh~jgv*9mbxljl5-EIimvu&KOL0WZpzZ1LcOu)9z zUQAa|V<1cHXO%&aVtsVVQk<0aU^W)QY|O!D@z=d{z0yxpLxV`LMw}fokEK% zOrG<9PJbb6Hi*$F7MVe$)9yRYUz#R_B(%&lV=Zo)s?#1!>lYTeZ2NH_UA#H+Kw~|& zZdaLd(&59fvuEotqQ)=G0MiZS#;L7lUv{ppvVesJAyPaq4QJfLzii9Q+d0gJW82A?kbkba4>eE})zhtpInBp>vsqYxg9g1|WbFP+=#yS~Kl#^?mX zbj?E?is)6xEX{QVC;*SGOTWTvR`nerDiivvh;GZE30HG6ZUDJzx(6?yETKbs534yq&i6 zI+C_L2!5ekI+XtstnW$~wWRUaR4W;>9t%d9-4v4*Mq&ruhjq0p@8p{%`NVvj&cs}E zw7IYO0|PEZ*}k^;ANm(oGjyC{x(;Zlql1S$HDk)(DQ%fP<(mkCHpRujHQq04ISaSx znm#G}(>hfT!MfJQXS`-)TTQAx_=x>ost~|c3T=ts|GQy#cKB6(dKm`XU5F16meT8< zzv-)yp9l;s6s~8Nh^6U|yu!+i!s#Z$WdN*gPJ%&tAtOw)#@)*1Cf@dn^Y7DM!;!9d zH#E(*`cXt`-?@EFh42EMMlyItjJzunbh3%pMteVy279-?OJr!f_-WQ^)9*YeN?9c2 zuK)w`RSwy=C<2)7521vj-NcAuV_3p`1F3Sow6F-g0l@$(Bvzy{bMR@yVdTCx-sD@Z z9Js=BV_+4%*|QXA%&iq`PK!+0=+kpZNDg}xJZ7rTo)|4XEB+AHDVnAv!xsU43B}yU z;;3G^0Do}(nKzGr5)=DtuQ7GWXvS@$e7(F*n7|^fXP1_>f=kADyUv{9w-o}}vd%|` z(`KzA{QAzy)>ONH7yh065pM=X5OPnEP992vS!Rkh#&@$U{;8z%%KRXtg$gS0HIgbP z-Toy0@t|x$y}ectC~w^@Nignbknu=EK65+PkMec!6wU9Xs9l%&zQ$F^i~Y86hqm&> zz{KxQr>Lc&YjxQ>(cFA7G)l#T>(!3MkW>#dwqd#V=U;KI(`{B}f#fyw5Q&OWf~jiK z3gb^BVQnx&pz9~|DR*lMakkPDX6kdt5-nO{4M^i%;RnS>^JLyPFf){*bCa52#Gg7^ z4}5v?LOJXYmqJ@d6YW2tCCP!S<7WeKcIZvsD_ls3-gs5d(_bHo1$u+ZQtPF_5b004>#SJHx+f5$nMzM3FnDsbc5esbK zCROImtPhWs?1F)c*fIL~@0XQd#ZzbSlC9a@0f@Bkqy4r%Df$Weot72u2xhy~>6rd!JkFE!8Q6l06rAb_r8zn;(|%w5*Gf zTfl4E?47O(3mJQ#V>9-IHn);KDn=IVpo+cG>}j2ejrW9h^=XdGZ8JHIP2rz2SoHIj za;x)$-qyHW`)+|ariRxGH#@V*!4hH_&fq4}`AAx43IU!rf!tu%v2RA=1-T^gn7EW~ zb)TpIse5(z_+JiOJ#{W|AjV14knys%ARCD?^Jea4wIW)AK|^YEd^^F;Cq`fV=Gw;q z&~$8H!=>momMP)5h;(5{Ho5@p;5BokNnTLlA}id&y!7(xdDm{p&(Ls3{uR-Z@QLNr zY-UHf=)0X!^OiRv`wGZOoV}l5^b7UjI}rv$#WUZcZ8{}~%wAJS&$KiN_-53gRRs5v zlFC_YT@GD?@dYP*aSBYe3GF5$yl$#PhNxw}H1SKvNt#`zJKbFx=#Xzfn`z5oF<~oOcz@dd>T@Oq`2uUFxwF6^@X+5w@S&E=#*~6=S?xH_=6!#8h z&m9_3Ls6xR6D70yuj}h&<=9GaTE%^j8%;s0Li2`x_`USbMwz7zWPG%T*o*+jAMrmE zkS7~kEzaumZURjF121dRs;;@UA0kyD1M?~A`Bgnh7cRg&{!91y=%VqOVmhU22s*D9 z|D2fB_eE$oeQJHdsAy!x++tGX0Q+IF<0`77Z)LzdBqQmx$q1{&sj)tULg(L)0iUr$ z9R`rTqH4Q3T1AsGkD9y_v0flf|2#=Hk(5b^EW%Lz^NKoeO8Vc|m=ocb@>!I=$Y?3@ zNQ-?Ec3(^CoSW~;6_&#D`{s6A@?(U3wDC1Mr?wUN417p!#rKQL4IO-yHMf&1Y-$GEsM#B$A6%(v1z2EX$13ja@Tlq{Kd$=?i&3DEM zu^fzV$LWaQqDkSCEzW++9TT+LudX-*87lvlWpElOm;WK&_^z>qJ%iNaV&`Z90AB-q zv+DlNbmbg@0RYfd^9oG)e?TMF{0g_JsUGf$?KoP1t~NDjL~~6tJiD6UQ-np1us-4 z<8gM}PwC9EiMh;hr-?0YQRY=^)Q*e-ykhCX9A@nPnA4%EoFgBj)*;@s(2V&=!xG%- zW8SX|$~|9K$&^dXRLGZMt)R^?^=l?)A)LJx?GI>A?@EuXS ztM#-*IdX7RdCywnBOTxf$HIAPpHq};bFjfEY5a0QMVTc}k0l#nYLUJ-Deopyxp0nH z{GIq3zNl~ZDtI)IFS?f8ojeN_LPcYgAT1fux7M>o#kltcvad{0(ABKb?>$=VA{xg( z{kKY31Lvx-9{`8TxQK*5+Ou;qwom#@H?Ne8D=x+}<_C%XQkSKG!N^w-d=G_$P1 z+UcFj-7{KS#JsVhA!D<-4vU2<8FxH=cbBiqW{KMeoXTtR&ns;#J}^;A|Le@qGE(ei z0;ifuRaNt^S@0k`m5P^beb|2&w33X^dEL9x#4p{M0eB?{?(@z{YGlyaC2oT>93c_s z?knO4<`Kz7{2^}smjA&y-rCH93M4QKH5?3yb-@L@KF|#!+sF?$V|mGcO1G}^Y2k}M zi9vo#1FxCSlU;aIqzJnws;M5U48qxvJdo(Re}vB203pGBf=L6mO{;yN!9Yj;hdqlc zg>w!%id07@t(()T_7Yv>iLu~&X8H*T86i)@_nB($K}8iUueCpk#T+wB~t?z5gS}Q-16=L2GEd3lD9J_PD^Xrl@ArC`EPZLHw&Nk%- zDUkRNXyW+>=_|i!PEhPh66Fs;EdB}1G$%?_OSY8pucmE&*nrn|Si_(786KXkNMefA zAyPioe227VaS|;c5dqxiS}gftO4@kWix<)7UP{PsIxHfk_v?aaXJj)8TRJI5}a zckTqQ%u*Ke`2Y+dPgYlt4|UY%^d6k{2VPYeF4*Cnqv3^EGC^mf?Vu+sMs#YA?Co>j zu!{4O6o*XYn+5QQ4b~N+{YW8&oBzEC1_>dg40b|&POjR;KBt43>%KG; zs7qXYB23>lGqp$R5&3R7yV3vXCvT8=T%K8O^?~VXk~X@Kbu*y8yUMd8#0QViS}!J; zeMc2z`yLwG0g*m^vnOVF925RW9zwsg>ikdVtEPWdPJNQDN1A&;tu#se<3 zdq{ODfnuiOUZs=w-z=XqoC+?#9jfk8tGw;J{BMM%{|{ZUpzj$8-x0%Cp++a``uj;p z>!ZVz#LmdGB6&-*I3w`n8@8U(x0N2e#^a8A1Gcc7Jj-aJw`NtFsrMMdY~L789wrty zyMDfm$#3KaIgY7&tBg#NDn@&Qme`r9K0u|IqeQAJ|pJwWs@k zjt85AKustAZ89B$Z%6!xN~dAJK&e}2ivwsqUU?gvI{q&Pm_EL_3l!rtirN&+osVsSzkVy=(Wf@CMwkAn2%!9E^i%9nUHMV3M24fe4 ziI6Qrn8`BKW0}oT41+Oxd;fvwyyrddFZbMY&-dJ)?hp49XJch5A|x#Y002bHAjWqA z0KT~2y_evT-}MP{fA#mAXl86=ADXvHML(R~0)G10a?9nMyNH>b*oknB8#80a%oZ-B z+W4KR%lGfgJ3HXqH~l^MWJus>()*+)VL!(3=ezL<+l81}+5DuKDU6|3)|1$T#)N`V z6#AjqHO1mr^lQD}0t!hSZpR|GgB!KhnLWgNLpr)BIzGfP;P9e43n?@Tr@f-Jb=QIq z@Zl5XksAPTlc%5r0GLD{27Gv(0sx#oaS{Mf1Rnz2H--QJ34(tBo}G~A16=(dLezV# zLx2xZQ%E<6W4;nAYW`_&<~$ooqx^DBd9|CoXugqG!nm1IDJ>D)>w_V1bUvf z3}SHQi*cq$KJyj%lr7mmE{|9jHFN&jXnJsZ-A*xnx)KGEz=N{pM-Omn)Rnz11r zBbg#&Ct^?go8+XYU`qt_hf#mrPF;JMeg0bG7XcTbXB^g;t;^y(-9z$IByEB96Ja^W z0@{arJt(`fStY?kudM;0Fz7ebyNwZ%!7P5W)B;`?=@a=3!OK;MeIN~ON8hn0-qdTBOe!Au>R~n#Z+sm; z7safvkXfvOn4~ROG%3#ErB`E*@C$$g(>4CYWF#1u;2@Br9R-Oh>by&WEj^CQRgTd@ zZ{mU>ZAXRXm9Ol7^Ju-+XzSj808YLbBa_vlMmfsjD*=GQML6u;qGYSpQ zLi5E9HBbIxNe(oIn8B7DuX>o0*^EY}bEE&ojW)BK9Gv-cX)Ao&ckrf)F1qH$ zQ^Z<(i9Muc-nQx|@dAaW>U3N}l34Nt3xRg|65;NVZZ0OY#m?u6h?%xT#E&)It$F+q zFUBO?XKSE^j4LzPst?TmqEFa1Un!47Bs0YD`?uzJjkgu_zYj`Wd)6i#*RK5sAzw(H5*21Q zSMMzZb>{oo?$0h$e$H+(4Laxd64tp(ldM_4)83Zd@an!sNQV>W4$B}W4@LneW0(5BsG?Qf_nb}FP;&-(Zl<$-fk8p zC(j=%Sp#>&`Z49}ZHpLCK{BM##%Elo`({sp#ddDe=q83N{jBZT=G5(x%Nlg{-D)Ad zQS||S)h73E!Z5Oo0=+ zz-WgekG0}oMjj~e&jr0BQ6Z$Ngr$t3ak`U8Y(wWa6t(InKg&c{u|j8<)>}|HF@Dp+ zPw>2T&dOJHV6QaVZ~XZsLZwc*sRgLrIYmzUoD-U36Bw zigYY9&9BFyWm&@=F{Q|7s0D&?A4s2~E*`gh)M7@xwbqHFx5_F8`3Su1o|~v^-2G4! z-@2s+!l>S05^j$~aj)-k=M7S%Xa*^?U&!1W8{aN>89vk{*JNt@$SNrc!{}bss>B;Z z6LRt%^K4$c&SJ?U`u;kir8Y|E#sPwOR~%?o3%rYC^sSl<-CN`lFT@|irAuQ9ZaRh@fu+HxtaHb>m>0D zfeca@Y3IHBE#K_gsKm*J5jW*PllxNEAj&NuNB$`flVItDrnrFN4zLiCZarBrqRcM$ zfls&HgRL{cZ?SK``ZFJktU3bEBY(BBsw(4mIR*OKuAxF4O$KPUnXPO0{z~Uo^XwKG z&S&V8Qv+X2uNOU;<+^1zRhW$~S$dR`@`GVihR4nC*{{527G;Tx-3?uvnQ$Fi@ZF!J z-+wYpv~^xF6P*zz^YfLBRn65DL04yNh6nG|h3yAvG94^B?xGLY!~Crh`!FuI=PS2c zht@r;qp+U@t-O}mR9gw0*VZNOOA$LW9wN{ilcLE9qhFD86Y+NHO z?^%U+I}IayH3ht_$0T8~154CC;N($X;c$`#N{{%_Yf^iY+k2hm-e)}bn&L*fLBv6S zMZlh@MSJr)ma3E=XA-8_{baN+LE3RDM2A5=PTgkPo&jlIZ>;{%x%gs6i$|B4JK{H} zjCpO=K00sWViEq~!9kk@?E5IlrKTb`%J|)0jFi4KeVAn{<&_VDC&HE1VfkmLFA)oH zmsh`L+MwWIPV`5Fk@g68p`+5&trvK+&7%b@?{6v9>qZ>HL@1u;hPSPTp^&Sd%&5_# zj*0Je<&q9MgBbIsv!3wEy6AUKq<6-7KY~Y|^CHY!Wxu$mr7iX1r@xStO@bt9NsL8M>y*bn~xeTx%mmU z|6m?Pl6}S zl^2JMyyIubhfTesXJk+^Fj@|Z-VKUE+{Iy6BKf`M28GM@&^hR zMkxsAB&h8i_~Fm(bk2c6=auJh-nzoBKJrBjnZPh356i^UWf@gP0Rk-^(Sq@|S|w4rLO*%}m)ZGgZ~lZT;>L z_cObn5M&KD*#@WXEmb94>kd^1rEKi@+aj4*UnO6p)|e1T#;wQiw-#Qn&pXqUHz-x1Jg{ zqHKCkJs(PQt5vJ5EjKLO>hB~a$@}Rq2QWH}w_5%nVY|>eju&Yv&~TkB7GKNQ_+R}? zHU6PVPu0=ge}&P>MlCO~oLV|>&HLTNafgiz>aco5E7kJsf@7un*}^S0UTt6`BL zk;!JBZ+l(`kj-Z)-O@!noqsAr^7WW4%PBrrO1LZT_KN?St!`^eIyD#P=%;xS&3vsS zHGvG@Js)=j^%{R$2Be|RooKR5HdKzS+_)3#oCsF%{2UHtpE*n$i&VWR1PrgU-OMsF z9LS|^U@jMTR5v7epllp--l%!vl-O{&nO?VYREKx!4yhn(zejX&I{alUn3eh$HAf*MDEtOQg8i^re|Y@sn0pPKUT94K77%S&5!h zRVA!){toa;x~Qp%*j}vNt3VpPkXIVL&yLXk{v)%DVk~{_oV0}Bf8KraeYDWz2Em|&Yb7W{Fpg&o@bs%ia4u}M>`aiX03;Me zjzh8?bg>^!-2JkWfpuxSc+hy1>g%V8=!#wK*bUdKqY2%Ef>Um@K|+~uRthi4wcJrGX{~7< zbc!>5VEUvG-~N5|2($+Nb<|Ugyi&e82uXOxuzV|aZp!tP@n^pE?HLiGN_)$qbG|BHuDuBm#Xcx9fBdLBunwsL@*=+j-+mMR0 z8==BK2sx}Y#m7&YyQsz{4elT2%x9kQ$ti4`ue2x0vTD9 z-0Ryr7SJF$--uM>O%s!0;sWT@%!G~1?KfUrRRJ!T#pk4#TM}kfy{NM&o?cVVScDor zyw@^EjmrdFCzo58oTt3{;oy9PWz4S!F;R2s%bzWL?e1gm7V|4`^3x0dxqBQ}U2r~h zfCFc%8U#a`<6e{~6bhxJ9Zt!WkoeKn0>)3Du#8*%D9z2cuK6&IN{iP$65FPmdfAbEY8!*~{H?ZzKXWoI z>MTkHzFzWfaV?>N57oE<{ZMF8{R7oorC?>f?9wAig1ctpHZ`2^D z&kr534wv3H+-yi2plQIQJAr2}V)%hSQY5^yoDvnP#RqwH79LB$9L&at!XM%!B|?ue z+Sc4~1HRA^4_7Vc*02mw#^Zic@e}^aCD>cD=yp}*wgSDoCA%zm1qs@{UZfE49+xo> zuPVw~Fa)S0_JwToJ7iAb5uev+YfCSL-;C2pGjh8%f_Mg=i;2wZ!b>D!jC zFZ6PV3An>hz7OPdULYK+w3dP|mV>X@_8aOG$O2~$xEEDbs$oilE|{x2DYl|_`fhPl z^jQbKJ^|4$uJfyu-&c4?K0C%zL&;j@vG@G_60O{P2Q<5#W}HV*i;tq#9gf#kkR-?&2*cB?4y*%NovbH-9%a`4RbB)r$a+clZ|=0 zbQDojm8tfcUru|A=8Gp;H3b~(C++k^F!r>T?*AM%*;;9RMafN}df zu@W0?N_>`9jH;w$AF{7N?c1{6tHMDV{VI_+^L*N4SJG=bBUC1N4Ig*DX);gi^Vbwr zH#)R^FPQI{iqLPiWjMb4*6Z-*)SnpWMOf=asTaH#%}ncWoakQ)dzm*MFh^VRIdN7* zOsjvJX~C_MWjZu8rJ-VqxPkB6$&BwHXKwk5o!KI~=}Xk~f@*tKPxg+GE;#4CE}Aze z47DE3eIkCu%qRiFHjX}T%qXRh=Rl?kXGl+68>ioR7mOE$9a~C3)=#2#VhB2is1Ubp zl6dawnNDDy>)#>E7enduobFs*=c@=MUNz`)pzk6j5aJ!jHWzvDK72v5mn0YA2| z8_9zey7#$f7}BKRW*_%H1^@Cuu@q)LFT!;61%T^_Y#2VO_zK4xJi?U|xp~&3`LB(Z4oN>SkAME(}{2bib%ksVte*Gxm0;w;p?GuVPT{&c?yo z2@jS|HP_`$5;)@Z^ew4vnQ~6&vN9c`Tzq2cJ9$0R*f`<|xaF7gnw}9c>LuQ9KWWC+ z8+cxACWpMH@2FCLU@|)L`^)9{?rNh&aj-zcn&)!mooN3A5gjt}4oC=lAvv=um_K@v zSI)tDlQ(BYFsS6SH<`y(Z0OeAl0lW;?gt?=A^owo)h>vm=Ox-s3A^zTZ&=6+e>T&P zRV@A~oD_=9Z(6c#o%9J-@ktKdI)`{h^SwA9A5<7eTsG9PySuqzu3le=wU_n~9546< z4yQkMv_RNpDJHSS=Z!qj@s3!X5ot*4@)%t67|T%#9c99N(=axV(pLQeR<3WL8hZkj zq6rBmySuIsqXER~w9)lp12;uRk~ltt<$Y9nER}k}-(xxn=^t~7-b^Ldy3<%b?>h69 z#g6%1q<>5u*v*4>eAzJ*eC!CF6D6#R^YI_1HCsg`+2NyrOXbqLQN7>bZ<^71!dUi< z+}Sr=e$Q$CQt$Lpx_1KcT{c{M>Wfbu194Ga=6h4xzk7e(Y~l;T=+i%F{;gmL(vq~# z64C8RbtKRyQr~TRdJxVo{5LcLOu>7pZ?MxU!9$J37;U9^%`=+$ z)J!l`FC!^Il=OpYXXpNimO!o8_tmW&%#Tjdy{CeDv^{Gmy^Gkc16{FpDThBAR3x_D zO2iV2`euPW;MCASR*wyLZaz*Q#>YX~U`xQPi=F9EK0rOZwXvGWe1y^G#Gmdye;Jk3 zLA&}(0AEYur4rXi$CS05e*Z*Pt)Oqjn3XV2tpY<*7E+F4pzS&jbIId8v)Xp{q%O}3 z+r_%HMsanFyfUb5tCK zTu2XMC!(zq-;t;f)K!H#iHb4OR5XqL&jjkY3u5f~OLK3S8mma~TPd&oI7P?T1hZw8 zl2JBG9cnDuAF&1jDaXvp-@#bg-lriIC0X%6qAt_F8ChBgqpS#u`>NyI_}l}Ob)wXj zN%B-Lb>4oS^qi+DU~9#S)=sxRe6N*KArc&|(7d~_5y@Xt(T(T1Y`K*_Xkk9AVPAvh z+QWrzIX8R#U=U&GqyJ+{Y!0@ys&UG{#$F@}vC_>nmDPnjW1fQkhS8*>8Snm^yaWDo zC^YR=or~2vJ%w#bU`WV?NZIX&Po179#z>tN%>ryw$i(SJe}lbdfA^nt62msMsluB) zF>m-$o_oy`K9h@Yys6+tvrUF9Kzyqf z&RZU4OxlM!)R9*!ET>h;*EBUM1J_%s5#W}J_4NW-9i^H#oO9$dlWW~Y^d*Tn6gPJ! zK0gAt6MP!;M8$RQ8CWhaN=>q3Hmc9h&n^1_>gIud3pt4w#Br>hPjk0e$T>Q^AjNxX*ZS;_Y8u$dm`8>hFdjwP0-56Mgi Date: Thu, 28 Oct 2021 13:49:37 +0800 Subject: [PATCH 07/19] add batch tag (#16578) --- specification/cosmos-db/resource-manager/readme.go.md | 10 ++++++++++ .../resource-manager/readme.go.md | 10 ++++++++++ specification/network/resource-manager/readme.go.md | 10 ++++++++++ 3 files changed, 30 insertions(+) diff --git a/specification/cosmos-db/resource-manager/readme.go.md b/specification/cosmos-db/resource-manager/readme.go.md index 5f845b7b3223..87814591a12d 100644 --- a/specification/cosmos-db/resource-manager/readme.go.md +++ b/specification/cosmos-db/resource-manager/readme.go.md @@ -21,6 +21,7 @@ azure-arm: true ``` yaml $(go) && $(multiapi) batch: + - tag: package-2021-10 - tag: package-2021-07-preview - tag: package-2021-06 - tag: package-2021-05 @@ -39,6 +40,15 @@ batch: - tag: package-2015-04 ``` +### Tag: package-2021-10 and go + +These settings apply only when `--tag=package-2021-10 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2021-10' && $(go) +output-folder: $(go-sdk-folder)/services/cosmos-db/mgmt/2021-10-15/$(namespace) +``` + ### Tag: package-2021-07-preview and go These settings apply only when `--tag=package-2021-07-preview --go` is specified on the command line. diff --git a/specification/desktopvirtualization/resource-manager/readme.go.md b/specification/desktopvirtualization/resource-manager/readme.go.md index 6afe6985300d..8446235b9ddc 100644 --- a/specification/desktopvirtualization/resource-manager/readme.go.md +++ b/specification/desktopvirtualization/resource-manager/readme.go.md @@ -23,6 +23,16 @@ batch: - tag: package-2021-02-01-preview - tag: package-2021-03-09-preview - tag: package-2021-04-01-preview + - tag: package-preview-2021-09 +``` + +### Tag: package-preview-2021-09 and go + +These settings apply only when `--tag=package-preview-2021-09 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-preview-2021-09' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2021-09-03-preview/$(namespace) ``` ### Tag: package-2021-04-01-preview and go diff --git a/specification/network/resource-manager/readme.go.md b/specification/network/resource-manager/readme.go.md index 401787aadd6c..b84bb9241290 100644 --- a/specification/network/resource-manager/readme.go.md +++ b/specification/network/resource-manager/readme.go.md @@ -21,6 +21,7 @@ azure-arm: true ``` yaml $(go) && $(multiapi) batch: + - tag: package-2021-05 - tag: package-2021-03 - tag: package-2021-02 - tag: package-2020-11 @@ -61,6 +62,15 @@ batch: - tag: package-2015-05-preview ``` +### Tag: package-2021-05 and go + +These settings apply only when `--tag=package-2021-05 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2021-05' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2021-05-01/$(namespace) +``` + ### Tag: package-2021-03 and go These settings apply only when `--tag=package-2021-03 --go` is specified on the command line. From 2b56c8a3da0e04aea6f6d80a9ac04741d1ae5904 Mon Sep 17 00:00:00 2001 From: Jiefeng Chen <51037443+BigCat20196@users.noreply.github.com> Date: Thu, 28 Oct 2021 14:34:35 +0800 Subject: [PATCH 08/19] config desktopvirtualization readme and readme python (#16579) * config readme * Update readme.python.md Co-authored-by: Yuchao Yan --- .../resource-manager/readme.md | 2 +- .../resource-manager/readme.python.md | 34 ++++++++----------- 2 files changed, 16 insertions(+), 20 deletions(-) diff --git a/specification/desktopvirtualization/resource-manager/readme.md b/specification/desktopvirtualization/resource-manager/readme.md index fba7e680a56a..276a9c3df1db 100644 --- a/specification/desktopvirtualization/resource-manager/readme.md +++ b/specification/desktopvirtualization/resource-manager/readme.md @@ -149,7 +149,7 @@ This is not used by Autorest itself. swagger-to-sdk: - repo: azure-powershell - repo: azure-sdk-for-csharp - - repo: azure-sdk-for-python + - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-js diff --git a/specification/desktopvirtualization/resource-manager/readme.python.md b/specification/desktopvirtualization/resource-manager/readme.python.md index 454b0737ac27..1fb1b630a50c 100644 --- a/specification/desktopvirtualization/resource-manager/readme.python.md +++ b/specification/desktopvirtualization/resource-manager/readme.python.md @@ -2,26 +2,22 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -``` yaml $(python) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.desktopvirtualization - package-name: azure-mgmt-desktopvirtualization - package-version: 0.2.0 - clear-output-folder: true +``` yaml $(track2) +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +package-name: azure-mgmt-desktopvirtualization +no-namespace-folders: true +package-version: 1.0.0b1 +clear-output-folder: true ``` -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/azure-mgmt-desktopvirtualization/azure/mgmt/desktopvirtualization + +``` yaml $(python-mode) == 'update' && $(track2) +no-namespace-folders: true +output-folder: $(python-sdks-folder)/desktopvirtualization/azure-mgmt-desktopvirtualization/azure/mgmt/desktopvirtualization ``` -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/azure-mgmt-desktopvirtualization + +``` yaml $(python-mode) == 'create' && $(track2) +basic-setup-py: true +output-folder: $(python-sdks-folder)/desktopvirtualization/azure-mgmt-desktopvirtualization ``` From da8f07c9714d12730503976d23d94e16cb77d8dd Mon Sep 17 00:00:00 2001 From: Tom Harvey Date: Thu, 28 Oct 2021 11:03:19 +0200 Subject: [PATCH 09/19] marketplacenotifications: fixing an invalid operation id (#16326) Since both of these share the same operation id - neither is currently valid / can work as such this fixes these to use the canonical name (List and Get) based on the convention --- .../stable/2021-03-03/MarketplaceNotifications.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/marketplacenotifications/resource-manager/Microsoft.MarketplaceNotifications/stable/2021-03-03/MarketplaceNotifications.json b/specification/marketplacenotifications/resource-manager/Microsoft.MarketplaceNotifications/stable/2021-03-03/MarketplaceNotifications.json index 46c53b7f0a21..5cbb73ca9b36 100644 --- a/specification/marketplacenotifications/resource-manager/Microsoft.MarketplaceNotifications/stable/2021-03-03/MarketplaceNotifications.json +++ b/specification/marketplacenotifications/resource-manager/Microsoft.MarketplaceNotifications/stable/2021-03-03/MarketplaceNotifications.json @@ -21,7 +21,7 @@ "tags": [ "Notification" ], - "operationId": "Notifications_GetWithAuthorization", + "operationId": "Notifications_List", "parameters": [ { "$ref": "#/parameters/SubscriptionId" @@ -62,7 +62,7 @@ "tags": [ "Notification" ], - "operationId": "Notification_GetWithAuthorization", + "operationId": "Notification_Get", "parameters": [ { "$ref": "#/parameters/SubscriptionId" From 6d7653ffd37cdc781e16202306567e355b45ebf8 Mon Sep 17 00:00:00 2001 From: Rohan Kulkarni <36928710+rokulka@users.noreply.github.com> Date: Thu, 28 Oct 2021 22:20:52 +0530 Subject: [PATCH 10/19] [QuestionAnswering] Move stable version from feature branch to main (#16510) * move stable to main * fix validation failures * update operationIds * update model names * Rename properties with x-ms-client-name * Properly declare ShortAnswerOptions.enable as constant true After https://github.com/Azure/autorest/pull/4184, modelAsString: false must be added * Fix linting error Co-authored-by: Heath Stewart --- .../data-plane/Language/readme.md | 25 +- .../Language/stable/2021-10-01/common.json | 237 +++ .../SuccessfulQueryKnowledgebases.json | 99 + .../SuccessfulQueryText.json | 66 + .../authoring/SuccessfulCreateProject.json | 49 + .../authoring/SuccessfulDeleteProject.json | 12 + .../authoring/SuccessfulGetProject.json | 25 + .../authoring/SuccessfulGetQnas.json | 57 + .../authoring/SuccessfulGetSources.json | 31 + .../authoring/SuccessfulGetSynonyms.json | 30 + .../SuccessfulProjectDeleteJobStatus.json | 22 + .../SuccessfulProjectDeployJobStatus.json | 24 + .../SuccessfulProjectExportJobStatus.json | 24 + .../SuccessfulProjectImportJobStatus.json | 23 + .../SuccessfulProjectListDeployments.json | 22 + .../SuccessfulProjectSubmitDeployJob.json | 18 + .../SuccessfulProjectSubmitExportJob.json | 23 + .../SuccessfulProjectSubmitImportJob.json | 78 + .../SuccessfulProjectsListProjects.json | 35 + ...uccessfulUpdateActiveLearningFeedback.json | 26 + .../authoring/SuccessfulUpdateQnas.json | 74 + .../SuccessfulUpdateQnasJobStatus.json | 23 + .../authoring/SuccessfulUpdateSources.json | 44 + .../SuccessfulUpdateSourcesJobStatus.json | 23 + .../authoring/SuccessfulUpdateSynonyms.json | 28 + .../questionanswering-authoring.json | 1781 +++++++++++++++++ .../stable/2021-10-01/questionanswering.json | 585 ++++++ 27 files changed, 3482 insertions(+), 2 deletions(-) create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2021-10-01/common.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/SuccessfulQueryKnowledgebases.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/SuccessfulQueryText.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulCreateProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulDeleteProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulGetProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulGetQnas.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulGetSources.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulGetSynonyms.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulProjectDeleteJobStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulProjectDeployJobStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulProjectExportJobStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulProjectImportJobStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulProjectListDeployments.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulProjectSubmitDeployJob.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulProjectSubmitExportJob.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulProjectSubmitImportJob.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulProjectsListProjects.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulUpdateActiveLearningFeedback.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulUpdateQnas.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulUpdateQnasJobStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulUpdateSources.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulUpdateSourcesJobStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulUpdateSynonyms.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2021-10-01/questionanswering-authoring.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2021-10-01/questionanswering.json diff --git a/specification/cognitiveservices/data-plane/Language/readme.md b/specification/cognitiveservices/data-plane/Language/readme.md index 08317f46aceb..19f0faaa8f13 100644 --- a/specification/cognitiveservices/data-plane/Language/readme.md +++ b/specification/cognitiveservices/data-plane/Language/readme.md @@ -6,7 +6,15 @@ This is the AutoRest configuration file the Cognitive Services Language SDK. ## Releases -The current preview release is 2021-07-15-preview +The current stable release of QuestionAnswering is 2021-10-01 and preview release of Luis Deepstack is 2021-07-15-preview + + +```yaml +tag: release_2021_10_01 +add-credentials: true +clear-output-folder: true +openapi-type: data-plane +``` ```yaml tag: release_2021_07_15_preview @@ -21,6 +29,20 @@ add-credentials: true clear-output-folder: true ``` +### Release 2021-10-01 + +These settings apply only when `--tag=release_2021_10_01` is specified on the command line. + +``` yaml $(tag) == 'release_2021_10_01' +input-file: + - stable/2021-10-01/questionanswering.json + - stable/2021-10-01/questionanswering-authoring.json +title: + Microsoft Cognitive Language Service +modelerfour: + lenient-model-deduplication: true +``` + ### Release 2021-07-15-preview These settings apply only when `--tag=release_2021_07_15_preview` is specified on the command line. @@ -57,6 +79,5 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-net - - repo: azure-sdk-for-net-track2 - repo: azure-sdk-for-python ``` diff --git a/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/common.json b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/common.json new file mode 100644 index 000000000000..10f09c4bdd71 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/common.json @@ -0,0 +1,237 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft Cognitive Language Service", + "description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview.", + "version": "2021-10-01" + }, + "paths": {}, + "definitions": { + "ErrorResponse": { + "type": "object", + "description": "Error response.", + "additionalProperties": false, + "properties": { + "error": { + "description": "The error object.", + "$ref": "#/definitions/Error" + } + } + }, + "Error": { + "type": "object", + "description": "The error object.", + "additionalProperties": false, + "required": [ + "code", + "message" + ], + "properties": { + "code": { + "description": "One of a server-defined set of error codes.", + "$ref": "#/definitions/ErrorCode" + }, + "message": { + "type": "string", + "description": "A human-readable representation of the error." + }, + "target": { + "type": "string", + "description": "The target of the error." + }, + "details": { + "type": "array", + "description": "An array of details about specific errors that led to this reported error.", + "items": { + "$ref": "#/definitions/Error" + } + }, + "innererror": { + "description": "An object containing more specific information than the current object about the error.", + "$ref": "#/definitions/InnerErrorModel" + } + } + }, + "InnerErrorModel": { + "type": "object", + "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", + "additionalProperties": false, + "required": [ + "code", + "message" + ], + "properties": { + "code": { + "description": "One of a server-defined set of error codes.", + "$ref": "#/definitions/InnerErrorCode" + }, + "message": { + "type": "string", + "description": "Error message." + }, + "details": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Error details." + }, + "target": { + "type": "string", + "description": "Error target." + }, + "innererror": { + "description": "An object containing more specific information than the current object about the error.", + "$ref": "#/definitions/InnerErrorModel" + } + } + }, + "ErrorCode": { + "type": "string", + "description": "Human-readable error code.", + "x-ms-enum": { + "name": "ErrorCode", + "modelAsString": true + }, + "enum": [ + "InvalidRequest", + "InvalidArgument", + "Unauthorized", + "Forbidden", + "NotFound", + "ProjectNotFound", + "OperationNotFound", + "AzureCognitiveSearchNotFound", + "AzureCognitiveSearchIndexNotFound", + "TooManyRequests", + "AzureCognitiveSearchThrottling", + "AzureCognitiveSearchIndexLimitReached", + "InternalServerError", + "ServiceUnavailable" + ] + }, + "InnerErrorCode": { + "type": "string", + "description": "Human-readable error code.", + "x-ms-enum": { + "name": "InnerErrorCode", + "modelAsString": true + }, + "enum": [ + "InvalidRequest", + "InvalidParameterValue", + "KnowledgeBaseNotFound", + "AzureCognitiveSearchNotFound", + "AzureCognitiveSearchThrottling", + "ExtractionFailure" + ] + }, + "Language": { + "type": "string", + "description": "Language of the text records. This is BCP-47 representation of a language. For example, use \"en\" for English; \"es\" for Spanish etc. If not set, use \"en\" for English as default." + }, + "StringIndexType": { + "type": "string", + "description": "Specifies the method used to interpret string offsets. Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information see https://aka.ms/text-analytics-offsets.", + "default": "TextElements_v8", + "enum": [ + "TextElements_v8", + "UnicodeCodePoint", + "Utf16CodeUnit" + ], + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "value": "TextElements_v8", + "description": "Returned offset and length values will correspond to TextElements (Graphemes and Grapheme clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is written in .Net Framework or .Net Core and you will be using StringInfo." + }, + { + "value": "UnicodeCodePoint", + "description": "Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that support Unicode, for example Python." + }, + { + "value": "Utf16CodeUnit", + "description": "Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." + } + ] + } + } + }, + "parameters": { + "Endpoint": { + "name": "Endpoint", + "description": "Supported Cognitive Services endpoint (e.g., https://.api.cognitiveservices.azure.com).", + "x-ms-parameter-location": "client", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true + }, + "ProjectNameQueryParameter": { + "name": "projectName", + "in": "query", + "required": true, + "type": "string", + "description": "The name of the project to use.", + "x-ms-parameter-location": "method" + }, + "ProjectNamePathParameter": { + "name": "projectName", + "in": "path", + "required": true, + "type": "string", + "maxLength": 100, + "description": "The name of the project to use.", + "x-ms-parameter-location": "method" + }, + "DeploymentNameQueryParameter": { + "name": "deploymentName", + "in": "query", + "required": true, + "type": "string", + "description": "The name of the specific deployment of the project to use.", + "x-ms-parameter-location": "method" + }, + "DeploymentNamePathParameter": { + "name": "deploymentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the specific deployment of the project to use.", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API version." + }, + "TopParameter": { + "name": "top", + "in": "query", + "description": "The maximum number of resources to return from the collection.", + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "SkipParameter": { + "name": "skip", + "in": "query", + "description": "An offset into the collection of the first resource to be returned.", + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "MaxPageSizeParameter": { + "name": "maxpagesize", + "in": "query", + "description": "The maximum number of resources to include in a single response.", + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/SuccessfulQueryKnowledgebases.json b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/SuccessfulQueryKnowledgebases.json new file mode 100644 index 000000000000..60328232d911 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/SuccessfulQueryKnowledgebases.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2021-10-01", + "projectName": "proj1", + "deploymentName": "production", + "knowledgeBaseQueryOptions": { + "question": "how long it takes to charge surface?", + "top": 3, + "userId": "sd53lsY=", + "confidenceScoreThreshold": 0.20, + "context": { + "previousQnaId": 9, + "previousUserQuery": "Where are QnA Maker quickstarts?" + }, + "rankerType": "Default", + "filters": { + "metadataFilter": { + "metadata": [ + { + "key": "category", + "value": "api" + }, + { + "key": "editorial", + "value": "chitchat" + } + ], + "logicalOperation": "AND" + }, + "sourceFilter": [ + "filename1.pdf", + "https://www.wikipedia.org/microsoft" + ], + "logicalOperation": "AND" + }, + "answerSpanRequest": { + "enable": true, + "confidenceScoreThreshold": 0.20, + "topAnswersWithSpan": 1 + }, + "includeUnstructuredSources": true + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "answers": [ + { + "questions": [ + "Power and charging" + ], + "answer": "Power and charging**\n\nIt takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it.\n\nYou can use the USB port on your Surface Pro 4 power supply to charge other devices, like a phone, while your Surface charges. The USB port on the power supply is only for charging, not for data transfer. If you want to use a USB device, plug it into the USB port on your Surface.", + "confidenceScore": 0.65, + "id": 20, + "source": "surface-pro-4-user-guide-EN.pdf", + "metadata": { + "category": "api", + "editorial": "chitchat" + }, + "dialog": { + "isContextOnly": false, + "prompts": [ + { + "displayOrder": 1, + "qnaId": 23, + "displayText": "prompt1" + }, + { + "displayOrder": 2, + "qnaId": 36, + "displayText": "prompt2" + } + ] + }, + "answerSpan": { + "text": "two to four hours", + "confidenceScore": 0.30, + "offset": 33, + "length": 50 + } + }, + { + "questions": [ + "Charge your Surface Pro 4" + ], + "answer": "**Charge your Surface Pro 4**\n\n1. Connect the two parts of the power cord.\n\n2. Connect the power cord securely to the charging port.\n\n3. Plug the power supply into an electrical outlet.", + "confidenceScore": 0.32, + "id": 13, + "source": "surface-pro-4-user-guide-EN.pdf" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/SuccessfulQueryText.json b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/SuccessfulQueryText.json new file mode 100644 index 000000000000..cf2fcc810ed8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/SuccessfulQueryText.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2021-10-01", + "stringIndexType": "TextElements_v8", + "textQueryOptions": { + "question": "how long it takes to charge surface?", + "records": [ + { + "id": "1", + "text": "Power and charging. It takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it." + }, + { + "id": "2", + "text": "You can use the USB port on your Surface Pro 4 power supply to charge other devices, like a phone, while your Surface charges. The USB port on the power supply is only for charging, not for data transfer. If you want to use a USB device, plug it into the USB port on your Surface." + } + ], + "language": "en" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "answers": [ + { + "answer": "Power and charging. It takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it.", + "confidenceScore": 0.93, + "id": "1", + "answerSpan": { + "text": "two to four hours", + "confidenceScore": 0, + "offset": 28, + "length": 45 + }, + "offset": 0, + "length": 224 + }, + { + "answer": "It takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it.", + "confidenceScore": 0.92, + "id": "1", + "answerSpan": { + "text": "two to four hours", + "confidenceScore": 0, + "offset": 8, + "length": 25 + }, + "offset": 20, + "length": 224 + }, + { + "answer": "It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it.", + "confidenceScore": 0.05, + "id": "1", + "answerSpan": null, + "offset": 110, + "length": 244 + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulCreateProject.json b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulCreateProject.json new file mode 100644 index 000000000000..67504fa6d44b --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulCreateProject.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2021-10-01", + "projectName": "proj1", + "body": { + "description": "proj1 is a test project.", + "language": "en", + "settings": { + "defaultAnswer": "No good match found for your question in the Knowledgebase." + }, + "multilingualResource": true + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "projectName": "proj1", + "description": "proj1 is a test project.", + "language": "en", + "settings": { + "defaultAnswer": "No good match found for your question in the Knowledgebase." + }, + "multilingualResource": true, + "createdDateTime": "2021-05-01T15:13:22Z", + "lastModifiedDateTime": "2021-05-01T15:13:22Z", + "lastDeployedDateTime": "2021-05-01T15:13:22Z" + } + }, + "201": { + "headers": {}, + "body": { + "projectName": "proj1", + "description": "proj1 is a test project.", + "language": "en", + "settings": { + "defaultAnswer": "No good match found for your question in the Knowledgebase." + }, + "multilingualResource": true, + "createdDateTime": "2021-05-01T15:13:22Z", + "lastModifiedDateTime": "2021-05-01T15:13:22Z", + "lastDeployedDateTime": "2021-05-01T15:13:22Z" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulDeleteProject.json b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulDeleteProject.json new file mode 100644 index 000000000000..f253a50354a2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulDeleteProject.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2021-10-01", + "projectName": "proj1" + }, + "responses": { + "202": {} + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulGetProject.json b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulGetProject.json new file mode 100644 index 000000000000..6ad6e2fa0d75 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulGetProject.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2021-10-01", + "projectName": "proj1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "projectName": "proj1", + "description": "proj1 is a test project.", + "language": "en", + "settings": { + "defaultAnswer": "No good match found for your question in the Knowledgebase." + }, + "createdDateTime": "2021-05-01T15:13:22Z", + "lastModifiedDateTime": "2021-05-01T15:13:22Z", + "lastDeployedDateTime": "2021-05-01T15:13:22Z" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulGetQnas.json b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulGetQnas.json new file mode 100644 index 000000000000..fca3b45ad161 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulGetQnas.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2021-10-01", + "projectName": "proj1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": 1, + "answer": "ans1", + "source": "source1", + "questions": [ + "question 1.1", + "question 1.2" + ], + "metadata": { + "k1": "v1", + "k2": "v2" + }, + "dialog": { + "isContextOnly": false, + "prompts": [ + { + "displayOrder": 1, + "qnaId": 11, + "displayText": "prompt 1.1" + }, + { + "displayOrder": 2, + "qnaId": 21, + "displayText": "prompt 1.2" + } + ] + }, + "lastUpdatedDateTime": "2021-05-01T17:21:14Z" + }, + { + "id": 2, + "answer": "ans2", + "source": "source2", + "questions": [ + "question 2.1", + "question 2.2" + ], + "lastUpdatedDateTime": "2021-05-01T17:21:14Z" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulGetSources.json b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulGetSources.json new file mode 100644 index 000000000000..6bbeb525ab0b --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulGetSources.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2021-10-01", + "projectName": "proj1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "displayName": "source1", + "sourceUri": "https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview", + "sourceKind": "url", + "lastUpdatedDateTime": "2021-05-01T15:13:22Z" + }, + { + "displayName": "source2", + "sourceUri": "https://download.microsoft.com/download/2/9/B/29B20383-302C-4517-A006-B0186F04BE28/surface-pro-4-user-guide-EN.pdf", + "sourceKind": "file", + "contentStructureKind": "unstructured", + "lastUpdatedDateTime": "2021-05-01T15:13:22Z" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulGetSynonyms.json b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulGetSynonyms.json new file mode 100644 index 000000000000..bd467f4ef778 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulGetSynonyms.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2021-10-01", + "projectName": "proj1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "alterations": [ + "qnamaker", + "qna maker" + ] + }, + { + "alterations": [ + "botframework", + "bot framework" + ] + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulProjectDeleteJobStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulProjectDeleteJobStatus.json new file mode 100644 index 000000000000..e7909c8ef260 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulProjectDeleteJobStatus.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2021-10-01", + "jobId": "job1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "errors": [], + "createdDateTime": "2021-05-01T17:21:14Z", + "expirationDateTime": "2021-05-01T17:21:14Z", + "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a", + "lastUpdatedDateTime": "2021-05-01T17:21:14Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulProjectDeployJobStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulProjectDeployJobStatus.json new file mode 100644 index 000000000000..34b059ee399b --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulProjectDeployJobStatus.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2021-10-01", + "projectName": "proj1", + "deploymentName": "production", + "jobId": "job1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "errors": [], + "createdDateTime": "2021-05-01T17:21:14Z", + "expirationDateTime": "2021-05-01T17:21:14Z", + "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a", + "lastUpdatedDateTime": "2021-05-01T17:21:14Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulProjectExportJobStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulProjectExportJobStatus.json new file mode 100644 index 000000000000..93aa517176a9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulProjectExportJobStatus.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2021-10-01", + "projectName": "proj1", + "jobId": "job1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "errors": [], + "createdDateTime": "2021-05-01T17:21:14Z", + "expirationDateTime": "2021-05-01T17:21:14Z", + "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a", + "lastUpdatedDateTime": "2021-05-01T17:21:14Z", + "status": "succeeded", + "resultUrl": "https:///language/proj1/export/job1/result" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulProjectImportJobStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulProjectImportJobStatus.json new file mode 100644 index 000000000000..22cc3ea32019 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulProjectImportJobStatus.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2021-10-01", + "projectName": "proj1", + "jobId": "job1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "errors": [], + "createdDateTime": "2021-05-01T17:21:14Z", + "expirationDateTime": "2021-05-01T17:21:14Z", + "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a", + "lastUpdatedDateTime": "2021-05-01T17:21:14Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulProjectListDeployments.json b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulProjectListDeployments.json new file mode 100644 index 000000000000..2adf8de1039c --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulProjectListDeployments.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2021-10-01", + "projectName": "proj1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "deploymentName": "production", + "lastDeployedDateTime": "2021-05-01T15:13:22Z" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulProjectSubmitDeployJob.json b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulProjectSubmitDeployJob.json new file mode 100644 index 000000000000..3d9466a82c60 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulProjectSubmitDeployJob.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2021-10-01", + "projectName": "proj1", + "deploymentName": "production" + }, + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.", + "headers": { + "Operation-Location": "job1" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulProjectSubmitExportJob.json b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulProjectSubmitExportJob.json new file mode 100644 index 000000000000..c2d558a907c0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulProjectSubmitExportJob.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2021-10-01", + "projectName": "proj1", + "body": { + "exportAssetTypes": [ + "qnas", + "synonyms" + ] + } + }, + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.", + "headers": { + "Operation-Location": "job1" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulProjectSubmitImportJob.json b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulProjectSubmitImportJob.json new file mode 100644 index 000000000000..dc1ffddccb48 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulProjectSubmitImportJob.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2021-10-01", + "projectName": "proj1", + "body": { + "assets": { + "synonyms": [ + { + "alterations": [ + "wa", + "washington", + "washington state" + ] + }, + { + "alterations": [ + "U.S", + "usa", + "united states of america" + ] + } + ], + "qnas": [ + { + "lastUpdatedDateTime": "2021-05-01T17:21:14Z", + "id": 1, + "answer": "ans1", + "source": "source1", + "questions": [ + "question 1.1", + "question 1.2" + ], + "metadata": { + "k1": "v1", + "k2": "v2" + }, + "dialog": { + "isContextOnly": false, + "prompts": [ + { + "displayOrder": 1, + "qnaId": 11, + "displayText": "prompt 1.1" + }, + { + "displayOrder": 2, + "qnaId": 21, + "displayText": "prompt 1.2" + } + ] + } + }, + { + "lastUpdatedDateTime": "2021-05-01T17:21:14Z", + "id": 2, + "answer": "ans2", + "source": "source2", + "questions": [ + "question 2.1", + "question 2.2" + ] + } + ] + } + } + }, + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.", + "headers": { + "Operation-Location": "job1" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulProjectsListProjects.json b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulProjectsListProjects.json new file mode 100644 index 000000000000..24543bca92e4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulProjectsListProjects.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2021-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "projectName": "proj1", + "description": "proj1 is a test project.", + "language": "en", + "multilingualResource": true, + "createdDateTime": "2021-05-01T15:13:22Z", + "lastModifiedDateTime": "2021-05-01T15:13:22Z", + "lastDeployedDateTime": "2021-05-01T15:13:22Z" + }, + { + "projectName": "proj2", + "description": "proj2 is a test project.", + "language": "fr", + "multilingualResource": true, + "createdDateTime": "2021-05-01T15:13:22Z", + "lastModifiedDateTime": "2021-05-01T15:13:22Z", + "lastDeployedDateTime": "2021-05-01T15:13:22Z" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulUpdateActiveLearningFeedback.json b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulUpdateActiveLearningFeedback.json new file mode 100644 index 000000000000..a367a26e46c2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulUpdateActiveLearningFeedback.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2021-10-01", + "projectName": "proj1", + "body": { + "records": [ + { + "userId": "user1", + "userQuestion": "hi", + "qnaId": 1 + }, + { + "userId": "user1", + "userQuestion": "hello", + "qnaId": 2 + } + ] + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulUpdateQnas.json b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulUpdateQnas.json new file mode 100644 index 000000000000..6b895883e37e --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulUpdateQnas.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2021-10-01", + "projectName": "proj1", + "body": [ + { + "op": "add", + "value": { + "id": 3, + "answer": "ans3", + "source": "source1", + "questions": [ + "question 3.1", + "question 3.2" + ], + "metadata": { + "k1": "v1", + "k2": "v2" + }, + "dialog": { + "isContextOnly": false, + "prompts": [ + { + "displayOrder": 1, + "qnaId": 11, + "displayText": "prompt 3.1" + }, + { + "displayOrder": 2, + "qnaId": 21, + "displayText": "prompt 3.2" + } + ] + } + } + }, + { + "op": "replace", + "value": { + "id": 1, + "answer": "ans4", + "source": "source1", + "questions": [ + "question 4.1", + "question 4.2" + ] + } + }, + { + "op": "delete", + "value": { + "id": 2, + "answer": "ans2", + "source": "source1", + "questions": [ + "question 2.1", + "question 2.2" + ] + } + } + ] + }, + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.", + "headers": { + "Operation-Location": "job1" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulUpdateQnasJobStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulUpdateQnasJobStatus.json new file mode 100644 index 000000000000..22cc3ea32019 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulUpdateQnasJobStatus.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2021-10-01", + "projectName": "proj1", + "jobId": "job1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "errors": [], + "createdDateTime": "2021-05-01T17:21:14Z", + "expirationDateTime": "2021-05-01T17:21:14Z", + "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a", + "lastUpdatedDateTime": "2021-05-01T17:21:14Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulUpdateSources.json b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulUpdateSources.json new file mode 100644 index 000000000000..5854f376ceeb --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulUpdateSources.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2021-10-01", + "projectName": "proj1", + "body": [ + { + "op": "add", + "value": { + "displayName": "source3", + "sourceUri": "https://docs.microsoft.com/en-us/azure/cognitive-services/cognitive-services-support-options?context=/azure/cognitive-services/qnamaker/context/context", + "sourceKind": "url" + } + }, + { + "op": "replace", + "value": { + "displayName": "source1", + "sourceUri": "https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview", + "sourceKind": "url", + "refresh": true + } + }, + { + "op": "delete", + "value": { + "displayName": "source2", + "sourceUri": "https://download.microsoft.com/download/2/9/B/29B20383-302C-4517-A006-B0186F04BE28/surface-pro-4-user-guide-EN.pdf", + "sourceKind": "file" + } + } + ] + }, + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.", + "headers": { + "Operation-Location": "job1" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulUpdateSourcesJobStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulUpdateSourcesJobStatus.json new file mode 100644 index 000000000000..22cc3ea32019 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulUpdateSourcesJobStatus.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2021-10-01", + "projectName": "proj1", + "jobId": "job1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "errors": [], + "createdDateTime": "2021-05-01T17:21:14Z", + "expirationDateTime": "2021-05-01T17:21:14Z", + "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a", + "lastUpdatedDateTime": "2021-05-01T17:21:14Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulUpdateSynonyms.json b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulUpdateSynonyms.json new file mode 100644 index 000000000000..3a397db6860c --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulUpdateSynonyms.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2021-10-01", + "projectName": "proj1", + "body": { + "value": [ + { + "alterations": [ + "qnamaker", + "qna maker" + ] + }, + { + "alterations": [ + "botframework", + "bot framework" + ] + } + ] + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/questionanswering-authoring.json b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/questionanswering-authoring.json new file mode 100644 index 000000000000..3c42db5abf75 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/questionanswering-authoring.json @@ -0,0 +1,1781 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft Cognitive Language Service - Question Answering - Authoring", + "description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview.", + "version": "2021-10-01" + }, + "securityDefinitions": { + "apim_key": { + "type": "apiKey", + "name": "Ocp-Apim-Subscription-Key", + "in": "header" + } + }, + "security": [ + { + "apim_key": [] + } + ], + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}/language", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "common.json#/parameters/Endpoint" + } + ] + }, + "paths": { + "/query-knowledgebases/projects": { + "get": { + "summary": "Gets all projects for a user.", + "operationId": "QuestionAnsweringProjects_ListProjects", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "common.json#/parameters/TopParameter" + }, + { + "$ref": "common.json#/parameters/SkipParameter" + }, + { + "$ref": "common.json#/parameters/MaxPageSizeParameter" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + }, + "responses": { + "200": { + "description": "The metadata of all projects.", + "schema": { + "$ref": "#/definitions/ProjectsMetadata" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/questionanswering/authoring/SuccessfulProjectsListProjects.json" + } + } + } + }, + "/query-knowledgebases/projects/{projectName}": { + "get": { + "summary": "Get the requested project metadata.", + "operationId": "QuestionAnsweringProjects_GetProjectDetails", + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The metadata for the specified project.", + "schema": { + "$ref": "#/definitions/ProjectMetadata" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/questionanswering/authoring/SuccessfulGetProject.json" + } + } + }, + "patch": { + "summary": "Create or update a project.", + "operationId": "QuestionAnsweringProjects_CreateProject", + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "description": "Parameters needed to create the project.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CreateProjectOptions" + } + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The metadata of the updated project, if it already exists.", + "schema": { + "$ref": "#/definitions/ProjectMetadata" + } + }, + "201": { + "description": "The metadata of the created project, if it doesn't exist.", + "schema": { + "$ref": "#/definitions/ProjectMetadata" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/questionanswering/authoring/SuccessfulCreateProject.json" + } + } + }, + "delete": { + "summary": "Delete the project.", + "operationId": "QuestionAnsweringProjects_DeleteProject", + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "headers": { + "Operation-Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/questionanswering/authoring/SuccessfulDeleteProject.json" + } + } + } + }, + "/query-knowledgebases/projects/deletion-jobs/{jobId}": { + "get": { + "summary": "Gets the status of a Project delete job.", + "operationId": "QuestionAnsweringProjects_GetDeleteStatus", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/JobIdParameter" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Project delete job status.", + "schema": { + "$ref": "#/definitions/JobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/questionanswering/authoring/SuccessfulProjectDeleteJobStatus.json" + } + } + } + }, + "/query-knowledgebases/projects/{projectName}/:export": { + "post": { + "summary": "Export project metadata and assets.", + "operationId": "QuestionAnsweringProjects_Export", + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ImportExportFormatParameter" + }, + { + "$ref": "#/parameters/AssetKindParameter" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "headers": { + "Operation-Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/questionanswering/authoring/SuccessfulProjectSubmitExportJob.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/query-knowledgebases/projects/{projectName}/export/jobs/{jobId}": { + "get": { + "summary": "Gets the status of an Export job, once job completes, returns the project metadata, and assets.", + "operationId": "QuestionAnsweringProjects_GetExportStatus", + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/JobIdParameter" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Export job status, project metadata, and assets.", + "schema": { + "$ref": "#/definitions/ExportJobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/questionanswering/authoring/SuccessfulProjectExportJobStatus.json" + } + } + } + }, + "/query-knowledgebases/projects/{projectName}/:import": { + "post": { + "summary": "Import project assets.", + "operationId": "QuestionAnsweringProjects_Import", + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "description": "Project assets the needs to be imported.", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/ImportJobOptions" + } + }, + { + "$ref": "#/parameters/ImportExportFormatParameter" + }, + { + "$ref": "#/parameters/AssetKindParameter" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "headers": { + "Operation-Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/questionanswering/authoring/SuccessfulProjectSubmitImportJob.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/query-knowledgebases/projects/{projectName}/import/jobs/{jobId}": { + "get": { + "summary": "Gets the status of an Import job.", + "operationId": "QuestionAnsweringProjects_GetImportStatus", + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/JobIdParameter" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Import job status.", + "schema": { + "$ref": "#/definitions/JobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/questionanswering/authoring/SuccessfulProjectImportJobStatus.json" + } + } + } + }, + "/query-knowledgebases/projects/{projectName}/deployments/{deploymentName}": { + "put": { + "summary": "Deploy project to production.", + "operationId": "QuestionAnsweringProjects_DeployProject", + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/DeploymentNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "headers": { + "Operation-Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/questionanswering/authoring/SuccessfulProjectSubmitDeployJob.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/query-knowledgebases/projects/{projectName}/deployments/{deploymentName}/jobs/{jobId}": { + "get": { + "summary": "Gets the status of a Deploy job.", + "operationId": "QuestionAnsweringProjects_GetDeployStatus", + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/DeploymentNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/JobIdParameter" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Deploy job state.", + "schema": { + "$ref": "#/definitions/JobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/questionanswering/authoring/SuccessfulProjectDeployJobStatus.json" + } + } + } + }, + "/query-knowledgebases/projects/{projectName}/deployments": { + "get": { + "summary": "List all deployments of a project.", + "operationId": "QuestionAnsweringProjects_ListDeployments", + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "common.json#/parameters/TopParameter" + }, + { + "$ref": "common.json#/parameters/SkipParameter" + }, + { + "$ref": "common.json#/parameters/MaxPageSizeParameter" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + }, + "responses": { + "200": { + "description": "List of deployments of a project.", + "schema": { + "$ref": "#/definitions/ProjectDeployments" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/questionanswering/authoring/SuccessfulProjectListDeployments.json" + } + } + } + }, + "/query-knowledgebases/projects/{projectName}/synonyms": { + "get": { + "summary": "Gets all the synonyms of a project.", + "operationId": "QuestionAnsweringProjects_GetSynonyms", + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "common.json#/parameters/TopParameter" + }, + { + "$ref": "common.json#/parameters/SkipParameter" + }, + { + "$ref": "common.json#/parameters/MaxPageSizeParameter" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + }, + "responses": { + "200": { + "description": "All the synonyms of a project.", + "schema": { + "$ref": "#/definitions/SynonymAssets" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/questionanswering/authoring/SuccessfulGetSynonyms.json" + } + } + }, + "put": { + "summary": "Updates all the synonyms of a project.", + "operationId": "QuestionAnsweringProjects_UpdateSynonyms", + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "description": "All the synonyms of a project.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SynonymAssets" + } + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Synonyms update successfully." + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/questionanswering/authoring/SuccessfulUpdateSynonyms.json" + } + } + } + }, + "/query-knowledgebases/projects/{projectName}/sources": { + "get": { + "summary": "Gets all the sources of a project.", + "operationId": "QuestionAnsweringProjects_GetSources", + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "common.json#/parameters/TopParameter" + }, + { + "$ref": "common.json#/parameters/SkipParameter" + }, + { + "$ref": "common.json#/parameters/MaxPageSizeParameter" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + }, + "responses": { + "200": { + "description": "All the sources of a project.", + "schema": { + "$ref": "#/definitions/QnaSources" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/questionanswering/authoring/SuccessfulGetSources.json" + } + } + }, + "patch": { + "summary": "Updates the sources of a project.", + "operationId": "QuestionAnsweringProjects_UpdateSources", + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "description": "Update sources parameters of a project.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateSourcesOptions" + } + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "headers": { + "Operation-Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/questionanswering/authoring/SuccessfulUpdateSources.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/query-knowledgebases/projects/{projectName}/sources/jobs/{jobId}": { + "get": { + "summary": "Gets the status of update sources job.", + "operationId": "QuestionAnsweringProjects_GetUpdateSourcesStatus", + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/JobIdParameter" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Update sources job state.", + "schema": { + "$ref": "#/definitions/JobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/questionanswering/authoring/SuccessfulUpdateSourcesJobStatus.json" + } + } + } + }, + "/query-knowledgebases/projects/{projectName}/qnas": { + "get": { + "summary": "Gets all the QnAs of a project.", + "operationId": "QuestionAnsweringProjects_GetQnas", + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SourceFilterParameter" + }, + { + "$ref": "common.json#/parameters/TopParameter" + }, + { + "$ref": "common.json#/parameters/SkipParameter" + }, + { + "$ref": "common.json#/parameters/MaxPageSizeParameter" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + }, + "responses": { + "200": { + "description": "All the QnAs of a project.", + "schema": { + "$ref": "#/definitions/QnaAssets" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/questionanswering/authoring/SuccessfulGetQnas.json" + } + } + }, + "patch": { + "summary": "Updates the QnAs of a project.", + "operationId": "QuestionAnsweringProjects_UpdateQnas", + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "description": "Update QnAs parameters of a project.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateQnaOptions" + } + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "headers": { + "Operation-Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/questionanswering/authoring/SuccessfulUpdateQnas.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/query-knowledgebases/projects/{projectName}/qnas/jobs/{jobId}": { + "get": { + "summary": "Gets the status of update QnAs job.", + "operationId": "QuestionAnsweringProjects_GetUpdateQnasStatus", + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/JobIdParameter" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Update QnAs job state.", + "schema": { + "$ref": "#/definitions/JobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/questionanswering/authoring/SuccessfulUpdateQnasJobStatus.json" + } + } + } + }, + "/query-knowledgebases/projects/{projectName}/feedback": { + "post": { + "summary": "Update Active Learning feedback.", + "operationId": "QuestionAnsweringProjects_AddFeedback", + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "description": "Feedback for Active Learning.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ActiveLearningFeedback" + } + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Feedback recorded successfully." + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/questionanswering/authoring/SuccessfulUpdateActiveLearningFeedback.json" + } + } + } + } + }, + "definitions": { + "ActiveLearningFeedback": { + "type": "object", + "description": "Feedback for Active Learning.", + "additionalProperties": false, + "properties": { + "records": { + "$ref": "#/definitions/FeedbackRecords" + } + } + }, + "FeedbackRecords": { + "type": "array", + "description": "A list of Feedback Records for Active Learning.", + "additionalProperties": false, + "items": { + "$ref": "#/definitions/FeedbackRecord" + } + }, + "FeedbackRecord": { + "type": "object", + "description": "Feedback Record for Active Learning.", + "additionalProperties": false, + "properties": { + "userId": { + "type": "string", + "description": "Unique identifier of the user." + }, + "userQuestion": { + "type": "string", + "description": "User suggested question for the QnA." + }, + "qnaId": { + "type": "integer", + "description": "Unique ID of the QnA.", + "format": "int32" + } + } + }, + "ProjectsMetadata": { + "type": "object", + "description": "Collection of projects metadata and global settings.", + "additionalProperties": false, + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ProjectMetadata" + } + }, + "nextLink": { + "type": "string" + } + } + }, + "ProjectMetadata": { + "type": "object", + "description": "Represents the project.", + "additionalProperties": false, + "properties": { + "projectName": { + "type": "string", + "description": "Name of the project." + }, + "description": { + "type": "string", + "description": "Description of the project." + }, + "language": { + "$ref": "common.json#/definitions/Language" + }, + "multilingualResource": { + "type": "boolean", + "description": "Resource enabled for multiple languages across projects or not." + }, + "settings": { + "$ref": "#/definitions/ProjectSettings" + }, + "createdDateTime": { + "type": "string", + "description": "Project creation date-time.", + "format": "date-time" + }, + "lastModifiedDateTime": { + "type": "string", + "description": "Represents the project last modified date-time.", + "format": "date-time" + }, + "lastDeployedDateTime": { + "type": "string", + "description": "Represents the project last deployment date-time.", + "format": "date-time" + } + } + }, + "CreateProjectOptions": { + "type": "object", + "description": "Parameters needed to create the project.", + "additionalProperties": false, + "required": [ + "language" + ], + "properties": { + "description": { + "type": "string", + "description": "Description of the project." + }, + "language": { + "$ref": "common.json#/definitions/Language" + }, + "multilingualResource": { + "type": "boolean", + "description": "Set to true to enable creating knowledgebases in different languages for the same resource." + }, + "settings": { + "$ref": "#/definitions/ProjectSettings" + } + } + }, + "ProjectSettings": { + "type": "object", + "description": "Configurable settings of the Project.", + "additionalProperties": false, + "properties": { + "defaultAnswer": { + "type": "string", + "description": "Default Answer response when no good match is found in the knowledge base." + } + } + }, + "ImportJobOptions": { + "type": "object", + "description": "Project assets the needs to be imported.", + "additionalProperties": false, + "properties": { + "metadata": { + "$ref": "#/definitions/CreateProjectOptions" + }, + "assets": { + "$ref": "#/definitions/Assets" + }, + "fileUri": { + "type": "string", + "description": "Import data File URI." + } + } + }, + "JobMetadata": { + "description": "Represents the job metadata.", + "properties": { + "createdDateTime": { + "format": "date-time", + "type": "string" + }, + "expirationDateTime": { + "format": "date-time", + "type": "string" + }, + "jobId": { + "type": "string" + }, + "lastUpdatedDateTime": { + "format": "date-time", + "type": "string" + }, + "status": { + "$ref": "#/definitions/JobStatus" + } + }, + "required": [ + "jobId", + "lastUpdatedDateTime", + "createdDateTime", + "status" + ], + "type": "object" + }, + "JobStatus": { + "description": "Job Status.", + "enum": [ + "notStarted", + "running", + "succeeded", + "failed", + "cancelled", + "cancelling", + "partiallyCompleted" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "jobStatus" + } + }, + "JobState": { + "description": "Job state represents the job metadata and any errors.", + "allOf": [ + { + "$ref": "#/definitions/JobMetadata" + }, + { + "$ref": "#/definitions/Errors" + } + ] + }, + "Errors": { + "description": "Collection of Error types.", + "type": "object", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "common.json#/definitions/Error" + } + } + } + }, + "ExportJobState": { + "description": "Export job status, project metadata, and assets.", + "allOf": [ + { + "$ref": "#/definitions/JobState" + }, + { + "$ref": "#/definitions/ExportJobResultUrl" + } + ] + }, + "ExportJobResultUrl": { + "type": "object", + "description": "URL to download the result of the Export Job.", + "required": [ + "resultUrl" + ], + "properties": { + "resultUrl": { + "type": "string", + "description": "URL to download the result of the Export Job." + } + } + }, + "Assets": { + "type": "object", + "description": "All assets for this project.", + "additionalProperties": false, + "properties": { + "synonyms": { + "$ref": "#/definitions/SynonymAsset" + }, + "qnas": { + "$ref": "#/definitions/ImportQnaAsset" + } + } + }, + "SynonymAssets": { + "type": "object", + "description": "All synonym assets for this project.", + "additionalProperties": false, + "properties": { + "value": { + "$ref": "#/definitions/SynonymAsset" + }, + "nextLink": { + "type": "string" + } + } + }, + "SynonymAsset": { + "type": "array", + "description": "Collection of synonyms.", + "additionalProperties": false, + "maxLength": 10000, + "items": { + "$ref": "#/definitions/WordAlterations" + } + }, + "WordAlterations": { + "type": "object", + "description": "Collection of word alterations.", + "additionalProperties": false, + "required": [ + "alterations" + ], + "properties": { + "alterations": { + "type": "array", + "description": "Collection of word alterations.", + "maxLength": 20, + "items": { + "type": "string" + } + } + } + }, + "QnaAssets": { + "type": "object", + "description": "All QnA assets for the project.", + "additionalProperties": false, + "properties": { + "value": { + "$ref": "#/definitions/QnaAsset" + }, + "nextLink": { + "type": "string" + } + } + }, + "ImportQnaAsset": { + "type": "array", + "description": "List of QnA records to import.", + "additionalProperties": false, + "items": { + "$ref": "#/definitions/ImportQnaRecord" + } + }, + "QnaAsset": { + "type": "array", + "description": "List of QnA records.", + "additionalProperties": false, + "items": { + "$ref": "#/definitions/RetrieveQnaRecord" + } + }, + "QnaRecord": { + "type": "object", + "description": "QnA record.", + "additionalProperties": false, + "properties": { + "id": { + "type": "integer", + "description": "Unique ID for the QnA.", + "format": "int32" + }, + "answer": { + "type": "string", + "description": "Answer text.", + "maxLength": 25000, + "minLength": 1 + }, + "source": { + "type": "string", + "description": "Source from which QnA was indexed e.g. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs .", + "maxLength": 300 + }, + "questions": { + "type": "array", + "description": "List of questions associated with the answer.", + "maxLength": 100, + "minLength": 1, + "items": { + "type": "string" + } + }, + "metadata": { + "type": "object", + "description": "Metadata associated with the answer, useful to categorize or filter question answers.", + "additionalProperties": { + "type": "string" + } + }, + "dialog": { + "description": "Context of a QnA.", + "$ref": "#/definitions/QnaDialog" + }, + "activeLearningSuggestions": { + "type": "array", + "description": "List of Active Learning suggestions for the QnA.", + "items": { + "$ref": "#/definitions/SuggestedQuestionsCluster" + } + } + } + }, + "SuggestedQuestionsCluster": { + "type": "object", + "description": "Active Learning suggested questions cluster details.", + "additionalProperties": false, + "properties": { + "clusterHead": { + "type": "string", + "description": "Question chosen as the head of suggested questions cluster by Active Learning clustering algorithm." + }, + "suggestedQuestions": { + "type": "array", + "description": "List of all suggested questions for the QnA.", + "items": { + "$ref": "#/definitions/SuggestedQuestion" + } + } + } + }, + "SuggestedQuestion": { + "type": "object", + "description": "Question suggested by the Active Learning feature.", + "additionalProperties": false, + "properties": { + "question": { + "type": "string", + "description": "Question suggested by the Active Learning feature." + }, + "userSuggestedCount": { + "type": "integer", + "description": "The number of times the question was suggested explicitly by the user.", + "format": "int32" + }, + "autoSuggestedCount": { + "type": "integer", + "description": "The number of times the question was suggested automatically by the Active Learning algorithm.", + "format": "int32" + } + } + }, + "ImportQnaRecord": { + "description": "Import QnA Record.", + "allOf": [ + { + "$ref": "#/definitions/RetrieveQnaRecord" + }, + { + "$ref": "#/definitions/SourceDisplayNameParameter" + } + ] + }, + "SourceDisplayNameParameter": { + "type": "object", + "properties": { + "sourceDisplayName": { + "description": "Friendly name of the Source.", + "type": "string", + "maxLength": 200, + "minLength": 1 + } + } + }, + "RetrieveQnaRecord": { + "description": "QnA Record with last updated date-time.", + "allOf": [ + { + "$ref": "#/definitions/QnaRecord" + }, + { + "$ref": "#/definitions/LastUpdatedDateTimeParameter" + } + ] + }, + "LastUpdatedDateTimeParameter": { + "type": "object", + "description": "Last updated date-time parameter.", + "properties": { + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "Date-time when the QnA was last updated." + } + } + }, + "QnaDialog": { + "type": "object", + "description": "Dialog associated with QnA Record.", + "properties": { + "isContextOnly": { + "type": "boolean", + "description": "To mark if a prompt is relevant only with a previous question or not. If true, do not include this QnA as answer for queries without context; otherwise, ignores context and includes this QnA in answers." + }, + "prompts": { + "type": "array", + "description": "List of prompts associated with the answer.", + "maxItems": 20, + "items": { + "$ref": "#/definitions/QnaPrompt" + } + } + } + }, + "QnaPrompt": { + "type": "object", + "description": "Prompt for an answer.", + "properties": { + "displayOrder": { + "type": "integer", + "description": "Index of the prompt. It is used for ordering of the prompts.", + "format": "int32" + }, + "qnaId": { + "type": "integer", + "description": "ID of the QnA corresponding to the prompt.", + "format": "int32" + }, + "qna": { + "description": "QnA record. Either QnAId or QnA record needs to be present in a Prompt.", + "$ref": "#/definitions/QnaRecord" + }, + "displayText": { + "type": "string", + "description": "Text displayed to represent a follow up question prompt.", + "maxLength": 200 + } + } + }, + "UpdateOperationKind": { + "type": "string", + "description": "Update operation type for assets.", + "enum": [ + "add", + "delete", + "replace" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "updateOperationKind" + } + }, + "UpdateSourcesOptions": { + "type": "array", + "description": "A list of sources to be updated.", + "additionalProperties": false, + "items": { + "$ref": "#/definitions/UpdateSourceRecord" + } + }, + "UpdateQnaOptions": { + "type": "array", + "description": "A list of QnAs to be updated.", + "additionalProperties": false, + "items": { + "$ref": "#/definitions/UpdateQnaRecord" + } + }, + "UpdateQnaRecord": { + "type": "object", + "description": "QnA record to be updated.", + "additionalProperties": false, + "required": [ + "op", + "value" + ], + "properties": { + "op": { + "type": "string", + "$ref": "#/definitions/UpdateOperationKind" + }, + "value": { + "$ref": "#/definitions/QnaRecord" + } + } + }, + "UpdateSourceRecord": { + "type": "object", + "description": "Source to be updated.", + "additionalProperties": false, + "required": [ + "op", + "value" + ], + "properties": { + "op": { + "type": "string", + "$ref": "#/definitions/UpdateOperationKind" + }, + "value": { + "$ref": "#/definitions/UpdateQnaSourceRecord" + } + } + }, + "QnaSources": { + "type": "object", + "description": "All QnA sources for the project.", + "additionalProperties": false, + "properties": { + "value": { + "$ref": "#/definitions/QnaSourcesMetadata" + }, + "nextLink": { + "type": "string" + } + } + }, + "QnaSourcesMetadata": { + "type": "array", + "description": "Custom sources from which QnAs were extracted or explicitly added to the project.", + "additionalProperties": false, + "items": { + "$ref": "#/definitions/QnaSourceRecord" + } + }, + "QnaSourceRecord": { + "description": "Custom source record with last updated date-time.", + "allOf": [ + { + "$ref": "#/definitions/QnaSourceMetadata" + }, + { + "$ref": "#/definitions/LastUpdatedDateTimeParameter" + } + ] + }, + "UpdateQnaSourceRecord": { + "description": "Update source record.", + "allOf": [ + { + "$ref": "#/definitions/QnaSourceMetadata" + }, + { + "$ref": "#/definitions/RefreshSourceOptions" + } + ] + }, + "RefreshSourceOptions": { + "type": "object", + "description": "Boolean flag used to refresh data from the Source.", + "properties": { + "refresh": { + "type": "boolean", + "description": "Boolean flag used to refresh data from the Source." + } + } + }, + "QnaSourceMetadata": { + "type": "object", + "description": "Input source file or url details.", + "additionalProperties": false, + "required": [ + "sourceUri", + "sourceKind" + ], + "properties": { + "displayName": { + "type": "string", + "description": "Friendly name of the Source.", + "maxLength": 200, + "minLength": 1 + }, + "source": { + "type": "string", + "description": "Unique source identifier. Name of the file if it's a 'file' source; otherwise, the complete URL if it's a 'url' source." + }, + "sourceUri": { + "type": "string", + "description": "URI location for the file or url.", + "format": "uri" + }, + "sourceKind": { + "type": "string", + "$ref": "#/definitions/QnaSourceKind", + "default": "url" + }, + "contentStructureKind": { + "type": "string", + "$ref": "#/definitions/SourceContentStructureKind", + "default": "Unstructured" + } + } + }, + "QnaSourceKind": { + "type": "string", + "description": "Supported source types.", + "x-ms-enum": { + "name": "sourceKind", + "modelAsString": true + }, + "enum": [ + "file", + "url" + ] + }, + "SourceContentStructureKind": { + "type": "string", + "description": "Content structure type for sources.", + "enum": [ + "unstructured" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "sourceContentStructureKind" + } + }, + "ProjectDeployments": { + "type": "object", + "description": "All deployments of a project.", + "additionalProperties": false, + "properties": { + "value": { + "$ref": "#/definitions/ProjectDeploymentsList" + }, + "nextLink": { + "type": "string" + } + } + }, + "ProjectDeploymentsList": { + "type": "array", + "description": "List of deployments of a project.", + "additionalProperties": false, + "items": { + "$ref": "#/definitions/ProjectDeployment" + } + }, + "ProjectDeployment": { + "type": "object", + "description": "Project deployment details.", + "additionalProperties": false, + "properties": { + "deploymentName": { + "type": "string", + "description": "Name of the deployment." + }, + "lastDeployedDateTime": { + "type": "string", + "description": "Represents the project last deployment date-time.", + "format": "date-time" + } + } + } + }, + "parameters": { + "JobIdParameter": { + "name": "jobId", + "in": "path", + "description": "Job ID.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "AssetKindParameter": { + "name": "assetKind", + "type": "string", + "in": "query", + "description": "Kind of the asset of the project.", + "enum": [ + "qnas", + "synonyms" + ], + "x-ms-parameter-location": "method" + }, + "ImportExportFormatParameter": { + "name": "format", + "type": "string", + "in": "query", + "description": "Knowledge base Import or Export format.", + "default": "json", + "enum": [ + "json", + "tsv", + "excel" + ], + "x-ms-enum": { + "name": "format", + "modelAsString": true, + "values": [ + { + "value": "json", + "description": "Export or Import QnA assets in JSON format." + }, + { + "value": "tsv", + "description": "Export or Import knowledge base replica including all assets and metadata in Excel format." + }, + { + "value": "excel", + "description": "Export or Import knowledge base replica including all assets and metadata in Tsv format." + } + ] + }, + "x-ms-parameter-location": "method" + }, + "SourceFilterParameter": { + "name": "source", + "in": "query", + "description": "Source of the QnA.", + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/questionanswering.json b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/questionanswering.json new file mode 100644 index 000000000000..c528c3340170 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/questionanswering.json @@ -0,0 +1,585 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft Cognitive Language Service - Question Answering", + "description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview.", + "version": "2021-10-01" + }, + "securityDefinitions": { + "apim_key": { + "type": "apiKey", + "name": "Ocp-Apim-Subscription-Key", + "in": "header" + } + }, + "security": [ + { + "apim_key": [] + } + ], + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}/language", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "common.json#/parameters/Endpoint" + } + ] + }, + "paths": { + "/:query-knowledgebases": { + "post": { + "summary": "Answers the specified question using your knowledge base.", + "operationId": "QuestionAnswering_GetAnswers", + "parameters": [ + { + "$ref": "#/parameters/AnswersOptions" + }, + { + "$ref": "common.json#/parameters/ProjectNameQueryParameter" + }, + { + "$ref": "common.json#/parameters/DeploymentNameQueryParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "A successful response to get answers from knowledge base.", + "schema": { + "$ref": "#/definitions/AnswersResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/questionanswering/SuccessfulQueryKnowledgebases.json" + } + } + } + }, + "/:query-text": { + "post": { + "summary": "Answers the specified question using the provided text in the body.", + "operationId": "QuestionAnswering_GetAnswersFromText", + "parameters": [ + { + "$ref": "#/parameters/AnswersFromTextOptions" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "A successful response to get answers from input text.", + "schema": { + "$ref": "#/definitions/AnswersFromTextResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/questionanswering/SuccessfulQueryText.json" + } + } + } + } + }, + "definitions": { + "AnswersOptions": { + "type": "object", + "description": "Parameters to query a knowledge base.", + "additionalProperties": false, + "properties": { + "qnaId": { + "type": "integer", + "description": "Exact QnA ID to fetch from the knowledge base, this field takes priority over question.", + "format": "int32" + }, + "question": { + "type": "string", + "description": "User question to query against the knowledge base." + }, + "top": { + "type": "integer", + "description": "Max number of answers to be returned for the question.", + "format": "int32" + }, + "userId": { + "type": "string", + "description": "Unique identifier for the user." + }, + "confidenceScoreThreshold": { + "type": "number", + "format": "double", + "x-ms-client-name": "confidenceThreshold", + "description": "Minimum threshold score for answers, value ranges from 0 to 1.", + "maximum": 1, + "minimum": 0 + }, + "context": { + "description": "Context object with previous QnA's information.", + "$ref": "#/definitions/KnowledgeBaseAnswerContext" + }, + "rankerType": { + "type": "string", + "x-ms-client-name": "rankerKind", + "description": "Type of ranker to be used.", + "x-ms-enum": { + "name": "RankerKind", + "modelAsString": true, + "values": [ + { + "value": "QuestionOnly", + "description": "Question only ranker." + }, + { + "value": "Default", + "description": "Default ranker." + } + ] + }, + "enum": [ + "Default", + "QuestionOnly" + ] + }, + "filters": { + "description": "Filter QnAs based on given metadata list and knowledge base sources.", + "$ref": "#/definitions/QueryFilters" + }, + "answerSpanRequest": { + "x-ms-client-name": "shortAnswerOptions", + "description": "To configure Answer span prediction feature.", + "$ref": "#/definitions/ShortAnswerOptions" + }, + "includeUnstructuredSources": { + "type": "boolean", + "description": "(Optional) Flag to enable Query over Unstructured Sources." + } + } + }, + "ShortAnswerOptions": { + "type": "object", + "description": "To configure Answer span prediction feature.", + "additionalProperties": false, + "required": [ + "enable" + ], + "properties": { + "enable": { + "type": "boolean", + "description": "Enable or disable Answer Span prediction.", + "enum": [ + true + ], + "x-ms-enum": { + "name": "enable", + "modelAsString": false + } + }, + "confidenceScoreThreshold": { + "type": "number", + "format": "double", + "x-ms-client-name": "confidenceThreshold", + "description": "Minimum threshold score required to include an answer span, value ranges from 0 to 1.", + "maximum": 1, + "minimum": 0 + }, + "topAnswersWithSpan": { + "type": "integer", + "x-ms-client-name": "top", + "description": "Number of Top answers to be considered for span prediction from 1 to 10.", + "format": "int32", + "maximum": 10, + "minimum": 1 + } + } + }, + "KnowledgeBaseAnswerContext": { + "type": "object", + "description": "Context object with previous QnA's information.", + "additionalProperties": false, + "required": [ + "previousQnaId" + ], + "properties": { + "previousQnaId": { + "type": "integer", + "description": "Previous turn top answer result QnA ID.", + "format": "int32" + }, + "previousUserQuery": { + "type": "string", + "x-ms-client-name": "previousQuestion", + "description": "Previous user query." + } + } + }, + "AnswersResult": { + "type": "object", + "description": "Represents List of Question Answers.", + "additionalProperties": false, + "properties": { + "answers": { + "type": "array", + "description": "Represents Answer Result list.", + "items": { + "$ref": "#/definitions/KnowledgeBaseAnswer" + } + } + } + }, + "KnowledgeBaseAnswer": { + "type": "object", + "description": "Represents knowledge base answer.", + "additionalProperties": false, + "properties": { + "questions": { + "type": "array", + "description": "List of questions associated with the answer.", + "items": { + "type": "string" + } + }, + "answer": { + "type": "string", + "description": "Answer text." + }, + "confidenceScore": { + "type": "number", + "format": "double", + "x-ms-client-name": "confidence", + "description": "Answer confidence score, value ranges from 0 to 1.", + "maximum": 1, + "minimum": 0 + }, + "id": { + "type": "integer", + "x-ms-client-name": "qnaId", + "description": "ID of the QnA result.", + "format": "int32" + }, + "source": { + "type": "string", + "description": "Source of QnA result." + }, + "metadata": { + "type": "object", + "description": "Metadata associated with the answer, useful to categorize or filter question answers.", + "additionalProperties": { + "type": "string" + } + }, + "dialog": { + "type": "object", + "$ref": "#/definitions/KnowledgeBaseAnswerDialog" + }, + "answerSpan": { + "type": "object", + "x-ms-client-name": "shortAnswer", + "description": "Answer span object of QnA with respect to user's question.", + "$ref": "#/definitions/AnswerSpan" + } + } + }, + "KnowledgeBaseAnswerDialog": { + "type": "object", + "description": "Dialog associated with Answer.", + "properties": { + "isContextOnly": { + "type": "boolean", + "description": "To mark if a prompt is relevant only with a previous question or not. If true, do not include this QnA as search result for queries without context; otherwise, if false, ignores context and includes this QnA in search result." + }, + "prompts": { + "type": "array", + "description": "List of prompts associated with the answer.", + "maxItems": 20, + "items": { + "$ref": "#/definitions/KnowledgeBaseAnswerPrompt" + } + } + } + }, + "KnowledgeBaseAnswerPrompt": { + "type": "object", + "description": "Prompt for an answer.", + "properties": { + "displayOrder": { + "type": "integer", + "description": "Index of the prompt - used in ordering of the prompts.", + "format": "int32" + }, + "qnaId": { + "type": "integer", + "description": "QnA ID corresponding to the prompt.", + "format": "int32" + }, + "displayText": { + "type": "string", + "description": "Text displayed to represent a follow up question prompt.", + "maxLength": 200 + } + } + }, + "QueryFilters": { + "type": "object", + "description": "filters over knowledge base.", + "additionalProperties": false, + "properties": { + "metadataFilter": { + "type": "object", + "$ref": "#/definitions/MetadataFilter" + }, + "sourceFilter": { + "type": "object", + "$ref": "#/definitions/SourceFilter" + }, + "logicalOperation": { + "type": "string", + "description": "Logical operation used to join metadata filter with source filter.", + "$ref": "#/definitions/LogicalOperationKind", + "default": "AND" + } + } + }, + "MetadataFilter": { + "type": "object", + "description": "Find QnAs that are associated with the given list of metadata.", + "additionalProperties": false, + "properties": { + "metadata": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataRecord" + } + }, + "logicalOperation": { + "type": "string", + "description": "Operation used to join metadata filters.", + "$ref": "#/definitions/LogicalOperationKind", + "default": "AND" + } + } + }, + "MetadataRecord": { + "type": "object", + "description": "Object to provide the key value pair for each metadata.", + "additionalProperties": false, + "required": [ + "key", + "value" + ], + "properties": { + "key": { + "type": "string", + "description": "Metadata Key from Metadata dictionary used in the QnA." + }, + "value": { + "type": "string", + "description": "Metadata Value from Metadata dictionary used in the QnA." + } + } + }, + "LogicalOperationKind": { + "type": "string", + "description": "Set to 'OR' or 'AND' for using corresponding logical operation.", + "x-ms-enum": { + "name": "LogicalOperationKind", + "modelAsString": true + }, + "enum": [ + "AND", + "OR" + ] + }, + "SourceFilter": { + "type": "array", + "description": "Find QnAs that are associated with any of the given list of sources in knowledge base.", + "items": { + "type": "string" + } + }, + "AnswerSpan": { + "type": "object", + "description": "Answer span object of QnA.", + "additionalProperties": false, + "properties": { + "text": { + "type": "string", + "description": "Predicted text of answer span." + }, + "confidenceScore": { + "type": "number", + "x-ms-client-name": "confidence", + "description": "Predicted score of answer span, value ranges from 0 to 1.", + "format": "double", + "maximum": 1, + "minimum": 0 + }, + "offset": { + "type": "integer", + "description": "The answer span offset from the start of answer.", + "format": "int32" + }, + "length": { + "type": "integer", + "description": "The length of the answer span.", + "format": "int32" + } + } + }, + "AnswersFromTextOptions": { + "type": "object", + "description": "The question and text record parameters to answer.", + "required": [ + "question", + "records" + ], + "additionalProperties": false, + "properties": { + "question": { + "type": "string", + "description": "User question to query against the given text records." + }, + "records": { + "type": "array", + "x-ms-client-name": "textDocuments", + "description": "Text records to be searched for given question.", + "items": { + "$ref": "#/definitions/TextDocument" + } + }, + "language": { + "$ref": "common.json#/definitions/Language" + }, + "stringIndexType": { + "$ref": "common.json#/definitions/StringIndexType" + } + } + }, + "AnswersFromTextResult": { + "type": "object", + "description": "Represents the answer results.", + "additionalProperties": false, + "properties": { + "answers": { + "type": "array", + "description": "Represents the answer results.", + "items": { + "$ref": "#/definitions/TextAnswer" + } + } + } + }, + "TextAnswer": { + "type": "object", + "description": "Represents answer result.", + "additionalProperties": false, + "properties": { + "answer": { + "type": "string", + "description": "Answer." + }, + "confidenceScore": { + "type": "number", + "x-ms-client-name": "confidence", + "description": "answer confidence score, value ranges from 0 to 1.", + "format": "double", + "maximum": 1, + "minimum": 0 + }, + "id": { + "type": "string", + "description": "record ID." + }, + "answerSpan": { + "type": "object", + "x-ms-client-name": "shortAnswer", + "description": "Answer span object with respect to user's question.", + "$ref": "#/definitions/AnswerSpan" + }, + "offset": { + "type": "integer", + "description": "The sentence offset from the start of the document.", + "format": "int32" + }, + "length": { + "type": "integer", + "description": "The length of the sentence.", + "format": "int32" + } + } + }, + "TextDocument": { + "type": "object", + "description": "Represent input text record to be queried.", + "additionalProperties": false, + "required": [ + "id", + "text" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the text record." + }, + "text": { + "type": "string", + "description": "Text contents of the record." + } + } + } + }, + "parameters": { + "AnswersOptions": { + "name": "knowledgeBaseQueryOptions", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AnswersOptions" + }, + "x-nullable": true, + "description": "Post body of the request.", + "x-ms-parameter-location": "method" + }, + "AnswersFromTextOptions": { + "name": "textQueryOptions", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AnswersFromTextOptions" + }, + "x-nullable": true, + "description": "Post body of the request.", + "x-ms-parameter-location": "method" + } + } +} From c599abd70c39fa417d97dc59cbf5822f44b47f11 Mon Sep 17 00:00:00 2001 From: Parv Saxena Date: Thu, 28 Oct 2021 10:18:02 -0700 Subject: [PATCH 11/19] Add new version for scanning 2021-10-01-preview (for dns change) (#16447) * add new version for dns change * address check failures * fix readme path Co-authored-by: Parv Saxena --- .../ClassificationRules_CreateOrUpdate.json | 102 + .../examples/ClassificationRules_Delete.json | 53 + .../examples/ClassificationRules_Get.json | 48 + .../examples/ClassificationRules_ListAll.json | 84 + ..._ListVersionsByClassificationRuleName.json | 85 + ...icationRules_TagClassificationVersion.json | 19 + .../examples/DataSources_CreateOrUpdate.json | 53 + .../examples/DataSources_Delete.json | 31 + .../examples/DataSources_Get.json | 26 + .../examples/DataSources_ListAll.json | 42 + .../examples/Filters_CreateOrUpdate.json | 57 + .../examples/Filters_Get.json | 26 + .../examples/KeyVaultConnections_Create.json | 28 + .../examples/KeyVaultConnections_Delete.json | 27 + .../examples/KeyVaultConnections_Get.json | 22 + .../examples/KeyVaultConnections_ListAll.json | 36 + .../examples/ScanResult_CancelScan.json | 23 + .../examples/ScanResult_ListScanHistory.json | 59 + .../examples/ScanResult_RunScan.json | 24 + .../examples/ScanRulesets_CreateOrUpdate.json | 168 + .../examples/ScanRulesets_Delete.json | 36 + .../examples/ScanRulesets_Get.json | 31 + .../examples/ScanRulesets_ListAll.json | 28 + .../examples/Scans_CreateOrUpdate.json | 77 + .../examples/Scans_Delete.json | 41 + .../examples/Scans_Get.json | 36 + .../examples/Scans_ListByDataSource.json | 42 + .../examples/SystemScanRulesets_Get.json | 22 + .../SystemScanRulesets_GetByVersion.json | 22 + .../SystemScanRulesets_GetLatest.json | 21 + .../examples/SystemScanRulesets_ListAll.json | 35 + ...ScanRulesets_ListVersionsByDataSource.json | 36 + .../examples/Triggers_CreateTrigger.json | 95 + .../examples/Triggers_DeleteTrigger.json | 38 + .../examples/Triggers_GetTrigger.json | 32 + .../2021-10-01-preview/scanningService.json | 6937 +++++++++++++++++ specification/purview/data-plane/readme.md | 11 +- 37 files changed, 8552 insertions(+), 1 deletion(-) create mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/ClassificationRules_CreateOrUpdate.json create mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/ClassificationRules_Delete.json create mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/ClassificationRules_Get.json create mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/ClassificationRules_ListAll.json create mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/ClassificationRules_ListVersionsByClassificationRuleName.json create mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/ClassificationRules_TagClassificationVersion.json create mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/DataSources_CreateOrUpdate.json create mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/DataSources_Delete.json create mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/DataSources_Get.json create mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/DataSources_ListAll.json create mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/Filters_CreateOrUpdate.json create mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/Filters_Get.json create mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/KeyVaultConnections_Create.json create mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/KeyVaultConnections_Delete.json create mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/KeyVaultConnections_Get.json create mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/KeyVaultConnections_ListAll.json create mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/ScanResult_CancelScan.json create mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/ScanResult_ListScanHistory.json create mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/ScanResult_RunScan.json create mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/ScanRulesets_CreateOrUpdate.json create mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/ScanRulesets_Delete.json create mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/ScanRulesets_Get.json create mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/ScanRulesets_ListAll.json create mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/Scans_CreateOrUpdate.json create mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/Scans_Delete.json create mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/Scans_Get.json create mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/Scans_ListByDataSource.json create mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/SystemScanRulesets_Get.json create mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/SystemScanRulesets_GetByVersion.json create mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/SystemScanRulesets_GetLatest.json create mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/SystemScanRulesets_ListAll.json create mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/SystemScanRulesets_ListVersionsByDataSource.json create mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/Triggers_CreateTrigger.json create mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/Triggers_DeleteTrigger.json create mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/Triggers_GetTrigger.json create mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/scanningService.json diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/ClassificationRules_CreateOrUpdate.json b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/ClassificationRules_CreateOrUpdate.json new file mode 100644 index 000000000000..88ec5d7aa19f --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/ClassificationRules_CreateOrUpdate.json @@ -0,0 +1,102 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "classificationRuleName": "ClassificationRule1", + "api-version": "2021-10-01-preview", + "body": { + "kind": "Custom", + "properties": { + "description": "Let's put a cool desc here", + "classificationName": "MICROSOFT.FINANCIAL.AUSTRALIA.BANK_ACCOUNT_NUMBER", + "columnPatterns": [ + { + "pattern": "^data$", + "kind": "Regex" + } + ], + "dataPatterns": [ + { + "pattern": "^[0-9]{2}-[0-9]{4}-[0-9]{6}-[0-9]{3}$", + "kind": "Regex" + } + ], + "minimumPercentageMatch": 60, + "ruleStatus": "Enabled" + } + } + }, + "responses": { + "201": { + "headers": { + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888" + }, + "body": { + "id": "classificationRules/ClassificationRule1", + "name": "ClassificationRule1", + "kind": "Custom", + "properties": { + "minimumPercentageMatch": 80, + "classificationAction": "Keep", + "description": "second one", + "version": 4, + "classificationName": "MICROSOFT.FINANCIAL.AUSTRALIA.BANK_ACCOUNT_NUMBER", + "ruleStatus": "Enabled", + "createdAt": "2019-12-09T06:43:30.8478469Z", + "lastModifiedAt": "2019-12-09T07:04:53.2807344Z", + "dataPatterns": [ + { + "kind": "Regex", + "pattern": "^data1$" + }, + { + "kind": "Regex", + "pattern": "^data2$" + } + ], + "columnPatterns": [ + { + "kind": "Regex", + "pattern": "^column1$" + } + ] + } + } + }, + "200": { + "headers": { + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888" + }, + "body": { + "id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataCatalog/DataCatalogs/Catalog1/ClassificationRules/ClassificationRule1", + "name": "ClassificationRule1", + "kind": "Custom", + "properties": { + "minimumPercentageMatch": 80, + "classificationAction": "Keep", + "description": "second one", + "version": 4, + "classificationName": "MICROSOFT.FINANCIAL.AUSTRALIA.BANK_ACCOUNT_NUMBER", + "ruleStatus": "Enabled", + "createdAt": "2019-12-09T06:43:30.8478469Z", + "lastModifiedAt": "2019-12-09T07:04:53.2807344Z", + "dataPatterns": [ + { + "kind": "Regex", + "pattern": "^data1$" + }, + { + "kind": "Regex", + "pattern": "^data2$" + } + ], + "columnPatterns": [ + { + "kind": "Regex", + "pattern": "^column1$" + } + ] + } + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/ClassificationRules_Delete.json b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/ClassificationRules_Delete.json new file mode 100644 index 000000000000..ddccf22ac21d --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/ClassificationRules_Delete.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "subscriptionId": "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a", + "resourceGroupName": "SampleResourceGroup", + "dataCatalogName": "Catalog1", + "classificationRuleName": "ClassificationRule1", + "api-version": "2021-10-01-preview" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.DataCatalog/DataCatalogs/Catalog1/ClassificationRules/ClassificationRule1", + "name": "ClassificationRule1", + "kind": "Custom", + "properties": { + "minimumPercentageMatch": 80, + "classificationAction": "Keep", + "description": "second one", + "version": 4, + "classificationName": "CUSTOM.TEST.TWO", + "ruleStatus": "Enabled", + "createdAt": "2019-12-09T06:43:30.8478469Z", + "lastModifiedAt": "2019-12-09T07:04:53.2807344Z", + "dataPatterns": [ + { + "kind": "Regex", + "pattern": "^data1$" + }, + { + "kind": "Regex", + "pattern": "^data2$" + } + ], + "columnPatterns": [ + { + "kind": "Regex", + "pattern": "^column1$" + } + ] + } + } + }, + "204": { + "headers": { + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888" + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/ClassificationRules_Get.json b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/ClassificationRules_Get.json new file mode 100644 index 000000000000..d68e3592eab3 --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/ClassificationRules_Get.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "SampleResourceGroup", + "dataCatalogName": "Catalog1", + "classificationRuleName": "ClassificationRule1", + "api-version": "2021-10-01-preview" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.DataCatalog/DataCatalogs/Catalog1/ClassificationRules/ClassificationRule1", + "name": "ClassificationRule1", + "kind": "Custom", + "properties": { + "minimumPercentageMatch": 80, + "classificationAction": "Keep", + "description": "second one", + "version": 4, + "classificationName": "CUSTOM.TEST.TWO", + "ruleStatus": "Enabled", + "createdAt": "2019-12-09T06:43:30.8478469Z", + "lastModifiedAt": "2019-12-09T07:04:53.2807344Z", + "dataPatterns": [ + { + "kind": "Regex", + "pattern": "^data1$" + }, + { + "kind": "Regex", + "pattern": "^data2$" + } + ], + "columnPatterns": [ + { + "kind": "Regex", + "pattern": "^column1$" + } + ] + } + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/ClassificationRules_ListAll.json b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/ClassificationRules_ListAll.json new file mode 100644 index 000000000000..a0e5b942f7d2 --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/ClassificationRules_ListAll.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-10-01-preview", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "SampleResourceGroup", + "dataCatalogName": "Catalog1" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "8e58266a-de42-40d5-b3c4-c6a7e159cfba" + }, + "body": { + "count": 2, + "nextLink": null, + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.DataCatalog/DataCatalogs/Catalog1/ClassificationRules/ClassificationRule1", + "name": "ClassificationRule1", + "kind": "Custom", + "properties": { + "minimumPercentageMatch": 80, + "classificationAction": "Keep", + "description": "second one", + "version": 4, + "classificationName": "CUSTOM.TEST.TWO", + "ruleStatus": "Enabled", + "createdAt": "2019-12-09T06:43:30.8478469Z", + "lastModifiedAt": "2019-12-09T07:04:53.2807344Z", + "dataPatterns": [ + { + "kind": "Regex", + "pattern": "^data1$" + }, + { + "kind": "Regex", + "pattern": "^data2$" + } + ], + "columnPatterns": [ + { + "kind": "Regex", + "pattern": "^column1$" + } + ] + } + }, + { + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.DataCatalog/DataCatalogs/Catalog1/ClassificationRules/ClassificationRule2", + "name": "ClassificationRule2", + "kind": "Custom", + "properties": { + "minimumPercentageMatch": 80, + "classificationAction": "Keep", + "description": "second one", + "version": 4, + "classificationName": "CUSTOM.TEST.TWO", + "ruleStatus": "Enabled", + "createdAt": "2019-12-09T06:43:30.8478469Z", + "lastModifiedAt": "2019-12-09T07:04:53.2807344Z", + "dataPatterns": [ + { + "kind": "Regex", + "pattern": "^data1$" + }, + { + "kind": "Regex", + "pattern": "^data2$" + } + ], + "columnPatterns": [ + { + "kind": "Regex", + "pattern": "^column1$" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/ClassificationRules_ListVersionsByClassificationRuleName.json b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/ClassificationRules_ListVersionsByClassificationRuleName.json new file mode 100644 index 000000000000..0d44ce499efd --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/ClassificationRules_ListVersionsByClassificationRuleName.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-10-01-preview", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "SampleResourceGroup", + "dataCatalogName": "Catalog1", + "classificationRuleName": "ClassificationRule1" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "8e58266a-de42-40d5-b3c4-c6a7e159cfba" + }, + "body": { + "count": 2, + "nextLink": null, + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.DataCatalog/DataCatalogs/Catalog1/ClassificationRules/ClassificationRule1", + "name": "ClassificationRule1", + "kind": "Custom", + "properties": { + "minimumPercentageMatch": 80, + "classificationAction": "Keep", + "description": "second one", + "version": 2, + "classificationName": "CUSTOM.TEST.TWO", + "ruleStatus": "Enabled", + "createdAt": "2019-12-09T06:43:30.8478469Z", + "lastModifiedAt": "2019-12-09T07:04:53.2807344Z", + "dataPatterns": [ + { + "kind": "Regex", + "pattern": "^data1$" + }, + { + "kind": "Regex", + "pattern": "^data2$" + } + ], + "columnPatterns": [ + { + "kind": "Regex", + "pattern": "^column1$" + } + ] + } + }, + { + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.DataCatalog/DataCatalogs/Catalog1/ClassificationRules/ClassificationRule1", + "name": "ClassificationRule2", + "kind": "Custom", + "properties": { + "minimumPercentageMatch": 80, + "classificationAction": "Keep", + "description": "second one", + "version": 1, + "classificationName": "CUSTOM.TEST.TWO", + "ruleStatus": "Enabled", + "createdAt": "2019-12-09T06:43:30.8478469Z", + "lastModifiedAt": "2019-12-09T07:04:53.2807344Z", + "dataPatterns": [ + { + "kind": "Regex", + "pattern": "^data1$" + }, + { + "kind": "Regex", + "pattern": "^data2$" + } + ], + "columnPatterns": [ + { + "kind": "Regex", + "pattern": "^column1$" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/ClassificationRules_TagClassificationVersion.json b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/ClassificationRules_TagClassificationVersion.json new file mode 100644 index 000000000000..94cd6d0c4848 --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/ClassificationRules_TagClassificationVersion.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "classificationRuleName": "ClassificationRule1", + "classificationRuleVersion": 3, + "api-version": "2021-10-01-preview", + "action": "Keep" + }, + "responses": { + "202": { + "headers": { + "x-ms-request-id": "00000000-0000-0000-0000-00000000000" + }, + "body": { + "status": "Accepted" + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/DataSources_CreateOrUpdate.json b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/DataSources_CreateOrUpdate.json new file mode 100644 index 000000000000..dfd523919334 --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/DataSources_CreateOrUpdate.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "dataSourceName": "myDataSource", + "api-version": "2021-10-01-preview", + "body": { + "kind": "AzureStorage", + "properties": { + "endpoint": "https://azurestorage.core.windows.net/", + "collection": { + "referenceName": "Collection-rZX", + "type": "CollectionReference" + } + } + } + }, + "responses": { + "201": { + "headers": { + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888" + }, + "body": { + "name": "DataSource1", + "kind": "AzureStorage", + "properties": { + "endpoint": "https://azurestorage.core.windows.net/", + "collection": { + "lastModifiedAt": "2021-09-15T21:20:08.2944382Z", + "referenceName": "Collection-rZX", + "type": "CollectionReference" + } + } + } + }, + "200": { + "headers": { + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888" + }, + "body": { + "name": "DataSource1", + "kind": "AzureStorage", + "properties": { + "endpoint": "https://azurestorage.core.windows.net/", + "collection": { + "lastModifiedAt": "2021-09-15T21:20:08.2944382Z", + "referenceName": "Collection-rZX", + "type": "CollectionReference" + } + } + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/DataSources_Delete.json b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/DataSources_Delete.json new file mode 100644 index 000000000000..d90fe60e7f3e --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/DataSources_Delete.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "dataSourceName": "myDataSource", + "api-version": "2021-10-01-preview" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888" + }, + "body": { + "name": "DataSource1", + "kind": "AzureStorage", + "properties": { + "endpoint": "https://azurestorage.core.windows.net/", + "collection": { + "lastModifiedAt": "2021-09-15T21:20:08.2944382Z", + "referenceName": "Collection-rZX", + "type": "CollectionReference" + } + } + } + }, + "204": { + "headers": { + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888" + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/DataSources_Get.json b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/DataSources_Get.json new file mode 100644 index 000000000000..d74d15f84cc1 --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/DataSources_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "dataSourceName": "myDataSource", + "api-version": "2021-10-01-preview" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888" + }, + "body": { + "name": "DataSource1", + "kind": "AzureStorage", + "properties": { + "endpoint": "https://azurestorage.core.windows.net/", + "collection": { + "lastModifiedAt": "2021-09-15T21:20:08.2944382Z", + "referenceName": "Collection-rZX", + "type": "CollectionReference" + } + } + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/DataSources_ListAll.json b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/DataSources_ListAll.json new file mode 100644 index 000000000000..69630dd0e269 --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/DataSources_ListAll.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "dataSourceName": "myDataSource", + "api-version": "2021-10-01-preview" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "8e58266a-de42-40d5-b3c4-c6a7e159cfba" + }, + "body": { + "value": [ + { + "name": "DataSource1", + "kind": "AzureStorage", + "properties": { + "endpoint": "https://azurestorage1.core.windows.net/", + "collection": { + "lastModifiedAt": "2021-09-15T21:20:08.2944382Z", + "referenceName": "Collection-aZX", + "type": "CollectionReference" + } + } + }, + { + "name": "DataSource2", + "kind": "AzureStorage", + "properties": { + "endpoint": "https://azurestorage2.core.windows.net/", + "collection": { + "lastModifiedAt": "2021-09-15T21:20:08.2944382Z", + "referenceName": "Collection-rZX", + "type": "CollectionReference" + } + } + } + ] + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/Filters_CreateOrUpdate.json b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/Filters_CreateOrUpdate.json new file mode 100644 index 000000000000..bf2115ab3c39 --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/Filters_CreateOrUpdate.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "dataSourceName": "DataSource1", + "scanName": "Scan1", + "api-version": "2021-10-01-preview", + "body": { + "properties": { + "includeUriPrefixes": [ + "https://foo.file.core.windows.net/share1/user", + "https://foo.file.core.windows.net/share1/aggregated" + ], + "excludeUriPrefixes": [ + "https://foo.file.core.windows.net/share1/user/temp" + ] + } + } + }, + "responses": { + "201": { + "headers": { + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888" + }, + "body": { + "name": "custom", + "id": "datasources/myDataSource/scans/Scan1/filters/custom", + "properties": { + "includeUriPrefixes": [ + "https://foo.file.core.windows.net/share1/user", + "https://foo.file.core.windows.net/share1/aggregated" + ], + "excludeUriPrefixes": [ + "https://foo.file.core.windows.net/share1/user/temp" + ] + } + } + }, + "200": { + "headers": { + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888" + }, + "body": { + "name": "custom", + "id": "datasources/myDataSource/scans/Scan1/filters/custom", + "properties": { + "includeUriPrefixes": [ + "https://foo.file.core.windows.net/share1/user", + "https://foo.file.core.windows.net/share1/aggregated" + ], + "excludeUriPrefixes": [ + "https://foo.file.core.windows.net/share1/user/temp" + ] + } + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/Filters_Get.json b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/Filters_Get.json new file mode 100644 index 000000000000..640b37b6dd90 --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/Filters_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "dataSourceName": "myDataSource", + "scanName": "myScanName", + "api-version": "2021-10-01-preview" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888" + }, + "body": { + "id": "datasources/myDataSource/scans/myScanName/filters/custom", + "name": "custom", + "properties": { + "includeUriPrefixes": [ + "mssql://bar.database.windows.net/core/dbo/business", + "mssql://bar.database.windows.net/core/dbo/processing" + ], + "excludeUriPrefixes": [] + } + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/KeyVaultConnections_Create.json b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/KeyVaultConnections_Create.json new file mode 100644 index 000000000000..df058a1047ac --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/KeyVaultConnections_Create.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "keyVaultName": "KeyVault1", + "api-version": "2021-10-01-preview", + "body": { + "properties": { + "baseUrl": "https://babylon-sample-kv.vault.azure.net/", + "description": "This is a Key Vault" + } + } + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888" + }, + "body": { + "properties": { + "baseUrl": "https://babylon-sample-kv.vault.azure.net/", + "description": "This is a Key Vault" + }, + "id": "/subscriptions/34fb3b81-27ab-4690-9d0b-668896fd288c/resourceGroups/scanning-df-westus2/providers/Microsoft.ProjectBabylon/accounts/babylon-128abf8c-ecea-4be6-8010-36d73cfad6e5/linkedservices/AzureKeyVault1", + "name": "KeyVault1" + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/KeyVaultConnections_Delete.json b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/KeyVaultConnections_Delete.json new file mode 100644 index 000000000000..a836e6cb1f20 --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/KeyVaultConnections_Delete.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "keyVaultName": "KeyVault1", + "api-version": "2021-10-01-preview" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888" + }, + "body": { + "properties": { + "baseUrl": "https://babylon-sample-kv.vault.azure.net/", + "description": "This is a Key Vault" + }, + "id": "/subscriptions/34fb3b81-27ab-4690-9d0b-668896fd288c/resourceGroups/scanning-df-westus2/providers/Microsoft.ProjectBabylon/accounts/babylon-128abf8c-ecea-4be6-8010-36d73cfad6e5/linkedservices/AzureKeyVault1", + "name": "KeyVault1" + } + }, + "204": { + "headers": { + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888" + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/KeyVaultConnections_Get.json b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/KeyVaultConnections_Get.json new file mode 100644 index 000000000000..5c7c6bf351b1 --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/KeyVaultConnections_Get.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-10-01-preview", + "keyVaultName": "KeyVault1" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888" + }, + "body": { + "properties": { + "baseUrl": "https://babylon-sample-kv.vault.azure.net/", + "description": "This is a Key Vault" + }, + "id": "/subscriptions/34fb3b81-27ab-4690-9d0b-668896fd288c/resourceGroups/scanning-df-westus2/providers/Microsoft.ProjectBabylon/accounts/babylon-128abf8c-ecea-4be6-8010-36d73cfad6e5/linkedservices/AzureKeyVault1", + "name": "KeyVault1" + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/KeyVaultConnections_ListAll.json b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/KeyVaultConnections_ListAll.json new file mode 100644 index 000000000000..331c33f12780 --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/KeyVaultConnections_ListAll.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-10-01-preview", + "skipToken": null + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "8e58266a-de42-40d5-b3c4-c6a7e159cfba" + }, + "body": { + "value": [ + { + "properties": { + "baseUrl": "https://babylon-sample-kv.vault.azure.net/", + "description": "This is a Key Vault" + }, + "id": "/subscriptions/34fb3b81-27ab-4690-9d0b-668896fd288c/resourceGroups/scanning-df-westus2/providers/Microsoft.ProjectBabylon/accounts/babylon-128abf8c-ecea-4be6-8010-36d73cfad6e5/linkedservices/AzureKeyVault1", + "name": "AzureKeyVault1" + }, + { + "properties": { + "baseUrl": "https://babylon-random-kv.vault.azure.net/", + "description": "This is a Key Vault" + }, + "id": "/subscriptions/34fb3b81-27ab-4690-9d0b-668896fd288c/resourceGroups/scanning-df-westus2/providers/Microsoft.ProjectBabylon/accounts/babylon-128abf8c-ecea-4be6-8010-36d73cfad6e5/linkedservices/AzureKeyVault2", + "name": "AzureKeyVault2" + } + ], + "count": 2, + "nextLink": null + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/ScanResult_CancelScan.json b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/ScanResult_CancelScan.json new file mode 100644 index 000000000000..b9cdddea9ea8 --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/ScanResult_CancelScan.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "dataSourceName": "myDataSource", + "scanName": "myScanName", + "api-version": "2021-10-01-preview", + "runId": "138301e4-f4f9-4ab5-b734-bac446b236e7" + }, + "responses": { + "202": { + "headers": { + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888" + }, + "body": { + "scanResultId": "138301e4-f4f9-4ab5-b734-bac446b236e7", + "startTime": "2019-05-16T17:01:37.3089193Z", + "endTime": null, + "status": "Accepted", + "error": null + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/ScanResult_ListScanHistory.json b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/ScanResult_ListScanHistory.json new file mode 100644 index 000000000000..b4fbe75563bf --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/ScanResult_ListScanHistory.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "dataSourceName": "DataSource1", + "scanName": "scan1", + "api-version": "2021-10-01-preview", + "skipToken": null + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888" + }, + "body": { + "value": [ + { + "id": "556ac46f-bd42-4e84-b1f5-2ac335384b9b", + "status": "Running", + "assetsDiscovered": 950, + "assetsClassified": 345, + "startTime": "2018-11-14T04:47:52.9614956Z", + "queuedTime": "2018-11-14T04:47:52.9614956Z", + "pipelineStartTime": "2018-11-14T04:47:52.9614956Z", + "endTime": null, + "runType": "Manual", + "scanRulesetType": "Custom" + }, + { + "id": "6346cde3-467e-41f1-9436-af096fd83247", + "status": "Succeeded", + "assetsDiscovered": 950, + "assetsClassified": 945, + "startTime": "2018-11-14T04:47:52.9614956Z", + "queuedTime": "2018-11-14T04:47:52.9614956Z", + "pipelineStartTime": "2018-11-14T04:47:52.9614956Z", + "endTime": "2018-11-14T05:17:52.9614956Z", + "runType": "Scheduled", + "scanRulesetType": "Custom" + }, + { + "id": "565e518f-da15-486d-8f0d-5269ea404df6", + "status": "Failed", + "assetsDiscovered": 0, + "assetsClassified": 0, + "startTime": "2018-11-14T04:47:52.9614956Z", + "queuedTime": "2018-11-14T04:47:52.9614956Z", + "pipelineStartTime": "2018-11-14T04:47:52.9614956Z", + "endTime": "2018-11-14T05:17:52.9614956Z", + "errorMessage": "You did a bad thing", + "runType": "Manual", + "scanRulesetType": "System" + } + ], + "count": 3, + "nextLink": null + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/ScanResult_RunScan.json b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/ScanResult_RunScan.json new file mode 100644 index 000000000000..018b3c0a395b --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/ScanResult_RunScan.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "dataSourceName": "testDataSourceName", + "scanName": "scan1", + "api-version": "2021-10-01-preview", + "runId": "138301e4-f4f9-4ab5-b734-bac446b236e7", + "scanLevel": "Full" + }, + "responses": { + "202": { + "headers": { + "x-ms-request-id": "00000000-0000-0000-0000-00000000000" + }, + "body": { + "scanResultId": "138301e4-f4f9-4ab5-b734-bac446b236e7", + "startTime": "2019-05-16T17:01:37.3089193Z", + "endTime": null, + "status": "Accepted", + "error": null + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/ScanRulesets_CreateOrUpdate.json b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/ScanRulesets_CreateOrUpdate.json new file mode 100644 index 000000000000..5ddde11d81f4 --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/ScanRulesets_CreateOrUpdate.json @@ -0,0 +1,168 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "scanRulesetName": "nyScanRulesetName", + "api-version": "2021-10-01-preview", + "body": { + "kind": "AzureStorage", + "scanRulesetType": "Custom", + "properties": { + "scanningRule": { + "fileExtensions": [ + "CSV", + "JSON", + "PSV", + "SSV", + "TSV", + "TXT", + "XML", + "PARQUET" + ], + "customFileExtensions": [ + { + "customFileType": { + "builtInType": null, + "customDelimiter": "$" + }, + "description": "model file type", + "enabled": true, + "fileExtension": ".model" + }, + { + "customFileType": { + "builtInType": "JSON", + "customDelimiter": null + }, + "description": "mdoel1 type", + "enabled": true, + "fileExtension": ".model1" + } + ] + }, + "description": null, + "excludedSystemClassifications": [ + "MICROSOFT.FINANCIAL.AUSTRALIA.BANK_ACCOUNT_NUMBER", + "MICROSOFT.MISCELLANEOUS.IPADDRESS" + ], + "includedCustomClassificationRuleNames": [ + "BF_PII", + "Dummy_Rule2" + ] + } + } + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888" + }, + "body": { + "kind": "AzureStorage", + "scanRulesetType": "Custom", + "id": "scanrulesets/nyScanRulesetName", + "name": "nyScanRulesetName", + "properties": { + "scanningRule": { + "fileExtensions": [ + "CSV", + "JSON", + "PSV", + "SSV", + "TSV", + "TXT", + "XML", + "PARQUET" + ], + "customFileExtensions": [ + { + "customFileType": { + "builtInType": null, + "customDelimiter": "$" + }, + "description": "model file type", + "enabled": true, + "fileExtension": ".model" + }, + { + "customFileType": { + "builtInType": "JSON", + "customDelimiter": null + }, + "description": "mdoel1 type", + "enabled": true, + "fileExtension": ".model1" + } + ] + }, + "createdAt": "2021-02-12T16:03:13.4377581Z", + "description": null, + "excludedSystemClassifications": [ + "MICROSOFT.FINANCIAL.AUSTRALIA.BANK_ACCOUNT_NUMBER", + "MICROSOFT.MISCELLANEOUS.IPADDRESS" + ], + "includedCustomClassificationRuleNames": [ + "BF_PII", + "Dummy_Rule2" + ], + "lastModifiedAt": "2021-02-12T16:03:13.4377582Z" + } + } + }, + "201": { + "headers": { + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888" + }, + "body": { + "kind": "AzureStorage", + "scanRulesetType": "Custom", + "id": "scanrulesets/nyScanRulesetName", + "name": "nyScanRulesetName", + "properties": { + "scanningRule": { + "fileExtensions": [ + "CSV", + "JSON", + "PSV", + "SSV", + "TSV", + "TXT", + "XML", + "PARQUET" + ], + "customFileExtensions": [ + { + "customFileType": { + "builtInType": null, + "customDelimiter": "$" + }, + "description": "model file type", + "enabled": true, + "fileExtension": ".model" + }, + { + "customFileType": { + "builtInType": "JSON", + "customDelimiter": null + }, + "description": "mdoel1 type", + "enabled": true, + "fileExtension": ".model1" + } + ] + }, + "createdAt": "2021-02-12T16:03:13.4377581Z", + "description": null, + "excludedSystemClassifications": [ + "MICROSOFT.FINANCIAL.AUSTRALIA.BANK_ACCOUNT_NUMBER", + "MICROSOFT.MISCELLANEOUS.IPADDRESS" + ], + "includedCustomClassificationRuleNames": [ + "BF_PII", + "Dummy_Rule2" + ], + "lastModifiedAt": "2021-02-12T16:03:13.4377582Z" + } + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/ScanRulesets_Delete.json b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/ScanRulesets_Delete.json new file mode 100644 index 000000000000..ef335b416040 --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/ScanRulesets_Delete.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "scanRulesetName": "myRuleSetName", + "api-version": "2021-10-01-preview" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888" + }, + "body": { + "properties": { + "scanningRule": { + "fileExtensions": [ + "CSV", + "JSON" + ] + }, + "createdAt": "2020-01-28T23:09:30.5185162Z", + "lastModifiedAt": "2020-01-28T23:10:07.3840172Z", + "excludedSystemClassifications": null, + "includedCustomClassificationRuleNames": null, + "description": null + }, + "kind": "AzureStorage", + "name": "myRuleSetName" + } + }, + "204": { + "headers": { + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888" + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/ScanRulesets_Get.json b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/ScanRulesets_Get.json new file mode 100644 index 000000000000..d5a7e2f6b774 --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/ScanRulesets_Get.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "scanRulesetName": "myRuleSetName", + "api-version": "2021-10-01-preview" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888" + }, + "body": { + "properties": { + "scanningRule": { + "fileExtensions": [ + "CSV", + "JSON" + ] + }, + "createdAt": "2020-01-28T23:09:30.5185162Z", + "lastModifiedAt": "2020-01-28T23:10:07.3840172Z", + "excludedSystemClassifications": null, + "includedCustomClassificationRuleNames": null, + "description": null + }, + "kind": "AzureStorage", + "name": "myRuleSetName" + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/ScanRulesets_ListAll.json b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/ScanRulesets_ListAll.json new file mode 100644 index 000000000000..580a6b602997 --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/ScanRulesets_ListAll.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "scanRulesetName": "nyScanRulesetName", + "api-version": "2021-10-01-preview" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888" + }, + "body": { + "count": 2, + "nextLink": null, + "value": [ + { + "name": "ScanRuleset1", + "kind": "AzureStorage" + }, + { + "name": "ScanRuleset2", + "kind": "AzureStorage" + } + ] + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/Scans_CreateOrUpdate.json b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/Scans_CreateOrUpdate.json new file mode 100644 index 000000000000..12a99d1bb5bc --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/Scans_CreateOrUpdate.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "dataSourceName": "myDataSource", + "scanName": "myScanName", + "api-version": "2021-10-01-preview", + "body": { + "kind": "AzureStorageCredential", + "properties": { + "credential": { + "referenceName": "CredentialAKV", + "credentialType": "AccountKey" + }, + "connectedVia": null, + "scanRulesetName": "AzureStorage", + "scanRulesetType": "System", + "collection": { + "referenceName": "Collection-rZX", + "type": "CollectionReference" + } + } + } + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888" + }, + "body": { + "name": "myScanName", + "id": "datasources/myDataSource/scans/myScanName", + "kind": "AzureStorageCredential", + "properties": { + "credential": { + "referenceName": "CredentialAKV", + "credentialType": "AccountKey" + }, + "connectedVia": null, + "scanRulesetName": "AzureStorage", + "scanRulesetType": "System", + "workers": null, + "collection": { + "lastModifiedAt": "2021-09-15T21:20:08.2944382Z", + "referenceName": "Collection-rZX", + "type": "CollectionReference" + } + }, + "scanResults": null + } + }, + "201": { + "headers": { + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888" + }, + "body": { + "name": "myScanName", + "id": "datasources/myDataSource/scans/myScanName", + "kind": "AzureStorageCredential", + "properties": { + "credential": { + "referenceName": "CredentialAKV", + "credentialType": "AccountKey" + }, + "scanRulesetName": "AzureStorage", + "scanRulesetType": "System", + "workers": null, + "collection": { + "lastModifiedAt": "2021-09-15T21:20:08.2944382Z", + "referenceName": "Collection-rZX", + "type": "CollectionReference" + } + }, + "scanResults": null + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/Scans_Delete.json b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/Scans_Delete.json new file mode 100644 index 000000000000..169104a04920 --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/Scans_Delete.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "dataSourceName": "myDataSource", + "scanName": "myScanName", + "api-version": "2021-10-01-preview" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888" + }, + "body": { + "name": "myScanName", + "id": "datasources/myDataSource/scans/myScanName", + "kind": "AzureStorageCredential", + "properties": { + "credential": { + "referenceName": "CredentialAKV", + "credentialType": "AccountKey" + }, + "connectedVia": null, + "scanRulesetName": "AzureStorage", + "scanRulesetType": "System", + "workers": null, + "collection": { + "lastModifiedAt": "2021-09-15T21:20:08.2944382Z", + "referenceName": "Collection-rZX", + "type": "CollectionReference" + } + }, + "scanResults": null + } + }, + "204": { + "headers": { + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888" + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/Scans_Get.json b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/Scans_Get.json new file mode 100644 index 000000000000..fb461a85ffd8 --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/Scans_Get.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "dataSourceName": "myDataSource", + "scanName": "myScanName", + "api-version": "2021-10-01-preview" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888" + }, + "body": { + "name": "myScanName", + "id": "datasources/myDataSource/scans/myScanName", + "kind": "AzureStorageCredential", + "properties": { + "credential": { + "referenceName": "CredentialAKV", + "credentialType": "AccountKey" + }, + "connectedVia": null, + "scanRulesetName": "AzureStorage", + "scanRulesetType": "System", + "workers": null, + "collection": { + "lastModifiedAt": "2021-09-15T21:20:08.2944382Z", + "referenceName": "Collection-rZX", + "type": "CollectionReference" + } + }, + "scanResults": null + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/Scans_ListByDataSource.json b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/Scans_ListByDataSource.json new file mode 100644 index 000000000000..db978419ebfc --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/Scans_ListByDataSource.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "dataSourceName": "myDataSource", + "api-version": "2021-10-01-preview", + "skipToken": null + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888" + }, + "body": { + "value": [ + { + "name": "myScanName", + "id": "datasources/myDataSource/scans/myScanName", + "kind": "AzureStorageCredential", + "properties": { + "credential": { + "referenceName": "CredentialAKV", + "credentialType": "AccountKey" + }, + "connectedVia": null, + "scanRulesetName": "AzureStorage", + "scanRulesetType": "System", + "workers": null, + "collection": { + "lastModifiedAt": "2021-09-15T21:20:08.2944382Z", + "referenceName": "Collection-rZX", + "type": "CollectionReference" + } + }, + "scanResults": null + } + ], + "count": 1, + "nextLink": null + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/SystemScanRulesets_Get.json b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/SystemScanRulesets_Get.json new file mode 100644 index 000000000000..e1a8a9c2d9b4 --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/SystemScanRulesets_Get.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-10-01-preview", + "dataSourceType": "AzureStorage" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888" + }, + "body": { + "kind": "AzureStorage", + "scanRulesetType": "System", + "status": "Enabled", + "version": 1, + "id": "systemscanrulesets/AzureStorage", + "name": "AzureStorage" + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/SystemScanRulesets_GetByVersion.json b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/SystemScanRulesets_GetByVersion.json new file mode 100644 index 000000000000..49bcccd0a5fb --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/SystemScanRulesets_GetByVersion.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-10-01-preview", + "dataSourceType": "AzureStorage", + "version": 1 + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888" + }, + "body": { + "scanRulesetType": "System", + "kind": "AzureStorage", + "name": "myRuleSetName", + "status": "Enabled", + "version": 1 + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/SystemScanRulesets_GetLatest.json b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/SystemScanRulesets_GetLatest.json new file mode 100644 index 000000000000..cd46e174b09e --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/SystemScanRulesets_GetLatest.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-10-01-preview", + "dataSourceType": "AzureStorage" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888" + }, + "body": { + "scanRulesetType": "System", + "kind": "AzureStorage", + "name": "myRuleSetName", + "status": "Enabled", + "version": 1 + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/SystemScanRulesets_ListAll.json b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/SystemScanRulesets_ListAll.json new file mode 100644 index 000000000000..e475cd33b794 --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/SystemScanRulesets_ListAll.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-10-01-preview" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888" + }, + "body": { + "count": 2, + "nextLink": null, + "value": [ + { + "scanRulesetType": "System", + "kind": "AzureStorage", + "status": "Enabled", + "version": 2, + "id": "systemscanrulesets/AzureStorage", + "name": "sample" + }, + { + "scanRulesetType": "System", + "kind": "AzureStorage", + "status": "Enabled", + "version": 1, + "id": "systemscanrulesets/AzureStorage", + "name": "sample" + } + ] + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/SystemScanRulesets_ListVersionsByDataSource.json b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/SystemScanRulesets_ListVersionsByDataSource.json new file mode 100644 index 000000000000..2a87516b87e3 --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/SystemScanRulesets_ListVersionsByDataSource.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-10-01-preview", + "dataSourceType": "AzureStorage" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888" + }, + "body": { + "count": 2, + "nextLink": null, + "value": [ + { + "scanRulesetType": "System", + "kind": "AzureStorage", + "status": "Enabled", + "version": 2, + "id": "systemscanrulesets/AzureStorage", + "name": "sample" + }, + { + "scanRulesetType": "System", + "kind": "AzureStorage", + "status": "Enabled", + "version": 1, + "id": "systemscanrulesets/AzureStorage", + "name": "sample" + } + ] + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/Triggers_CreateTrigger.json b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/Triggers_CreateTrigger.json new file mode 100644 index 000000000000..cff6eba0d48c --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/Triggers_CreateTrigger.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "dataSourceName": "DataSource1", + "scanName": "Scan1", + "triggerName": "Trigger1", + "api-version": "2021-10-01-preview", + "body": { + "properties": { + "recurrenceInterval": null, + "scanLevel": "Incremental", + "recurrence": { + "startTime": "2021-02-12T14:59:00.416Z", + "endTime": "2021-02-25T00:00:00.000Z", + "interval": 1, + "frequency": "Month", + "schedule": { + "hours": [ + 23 + ], + "minutes": [ + 56 + ], + "monthDays": [ + 10 + ] + } + } + } + } + }, + "responses": { + "201": { + "headers": { + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888" + }, + "body": { + "name": "Trigger1", + "id": "datasources/AzureBlob-DSTDParv/scans/Scan-PUl/triggers/default", + "properties": { + "recurrence": { + "frequency": "Month", + "interval": 4, + "startTime": "2021-02-12T14:59:00.416Z", + "endTime": "2021-02-25T00:00:00Z", + "schedule": { + "minutes": [ + 56 + ], + "hours": [ + 23 + ], + "weekDays": null, + "monthDays": null, + "monthlyOccurrences": [ + { + "day": "Wednesday", + "occurrence": 2 + } + ] + } + }, + "recurrenceInterval": null, + "createdAt": "2021-02-12T14:58:58.0478425Z", + "lastModifiedAt": "2021-02-12T15:39:53.6482996Z", + "lastScheduled": null, + "scanLevel": "Incremental" + } + } + }, + "200": { + "headers": { + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888" + }, + "body": { + "name": "Trigger1", + "id": "datasources/AzureBlob-DSTDParv/scans/Scan-PUl/triggers/default", + "properties": { + "recurrence": { + "frequency": "Month", + "interval": 1, + "startTime": "2020-06-03T19:15:00Z", + "endTime": "2020-06-03T19:22:00Z", + "schedule": null + }, + "recurrenceInterval": null, + "createdAt": "2020-06-11T05:15:04.1940429Z", + "lastModifiedAt": "2020-06-19T22:26:22.6514064Z", + "lastScheduled": null, + "scanLevel": "Incremental" + } + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/Triggers_DeleteTrigger.json b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/Triggers_DeleteTrigger.json new file mode 100644 index 000000000000..d37be2e5664e --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/Triggers_DeleteTrigger.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "dataSourceName": "DataSource1", + "scanName": "Scan1", + "triggerName": "Trigger1", + "api-version": "2021-10-01-preview" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888" + }, + "body": { + "name": "Trigger1", + "properties": { + "recurrence": { + "frequency": "Month", + "interval": 1, + "startTime": "2020-06-03T19:15:00Z", + "endTime": "2020-06-03T19:22:00Z", + "schedule": null + }, + "recurrenceInterval": null, + "createdAt": "2020-06-11T05:15:04.1940429Z", + "lastModifiedAt": "2020-06-19T22:26:22.6514064Z", + "lastScheduled": null, + "scanLevel": "Incremental" + } + } + }, + "204": { + "headers": { + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888" + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/Triggers_GetTrigger.json b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/Triggers_GetTrigger.json new file mode 100644 index 000000000000..54b28697e1f2 --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/examples/Triggers_GetTrigger.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "dataSourceName": "myDataSourceName", + "scanName": "myScanName", + "api-version": "2021-10-01-preview", + "triggerName": "myTriggerName" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888" + }, + "body": { + "properties": { + "recurrence": { + "frequency": "Month", + "interval": 1, + "startTime": "2020-06-03T19:15:00Z", + "endTime": "2020-06-03T19:22:00Z", + "schedule": null + }, + "recurrenceInterval": null, + "createdAt": "2020-06-11T05:15:04.1940429Z", + "lastModifiedAt": "2020-06-19T22:26:22.6514064Z", + "lastScheduled": null, + "scanLevel": "Incremental" + } + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/scanningService.json b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/scanningService.json new file mode 100644 index 000000000000..9ebc18611a72 --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/scanningService.json @@ -0,0 +1,6937 @@ +{ + "swagger": "2.0", + "info": { + "title": "MicrosoftScanningClient", + "description": "Creates a Microsoft.Scanning management client.", + "version": "2021-10-01-preview" + }, + "host": "purview.azure.com", + "basePath": "/scan", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + }, + "paths": { + "/azureKeyVaults/{keyVaultName}": { + "get": { + "tags": [ + "AzureKeyVaults" + ], + "description": "Gets key vault information", + "operationId": "KeyVaultConnections_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "keyVaultName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/AzureKeyVault" + } + }, + "default": { + "description": "An error response received from the Scanning Service", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "KeyVaultConnections_Get": { + "$ref": "./examples/KeyVaultConnections_Get.json" + } + } + }, + "put": { + "tags": [ + "AzureKeyVaults" + ], + "description": "Creates an instance of a key vault connection", + "operationId": "KeyVaultConnections_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "keyVaultName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AzureKeyVault" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/AzureKeyVault" + } + }, + "default": { + "description": "An error response received from the Scanning Service", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "KeyVaultConnections_Create": { + "$ref": "./examples/KeyVaultConnections_Create.json" + } + } + }, + "delete": { + "tags": [ + "AzureKeyVaults" + ], + "description": "Deletes the key vault connection associated with the account", + "operationId": "KeyVaultConnections_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "keyVaultName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/AzureKeyVault" + } + }, + "204": { + "description": "Success" + }, + "default": { + "description": "An error response received from the Scanning Service", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "KeyVaultConnections_Delete": { + "$ref": "./examples/KeyVaultConnections_Delete.json" + } + } + } + }, + "/azureKeyVaults": { + "get": { + "tags": [ + "AzureKeyVaults" + ], + "description": "List key vault connections in account", + "operationId": "KeyVaultConnections_ListAll", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/AzureKeyVaultList" + } + }, + "default": { + "description": "An error response received from the Scanning Service", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "KeyVaultConnections_ListAll": { + "$ref": "./examples/KeyVaultConnections_ListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/classificationrules/{classificationRuleName}": { + "get": { + "tags": [ + "ClassificationRules" + ], + "description": "Get a classification rule", + "operationId": "ClassificationRules_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "classificationRuleName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ClassificationRule" + } + }, + "default": { + "description": "An error response received from the Scanning Service", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "ClassificationRules_Get": { + "$ref": "./examples/ClassificationRules_Get.json" + } + } + }, + "put": { + "tags": [ + "ClassificationRules" + ], + "description": "Creates or Updates a classification rule", + "operationId": "ClassificationRules_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "classificationRuleName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/ClassificationRule" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ClassificationRule" + } + }, + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ClassificationRule" + } + }, + "default": { + "description": "An error response received from the Scanning Service", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "ClassificationRules_CreateOrUpdate": { + "$ref": "./examples/ClassificationRules_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "ClassificationRules" + ], + "description": "Deletes a classification rule", + "operationId": "ClassificationRules_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "classificationRuleName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ClassificationRule" + } + }, + "204": { + "description": "Success" + }, + "default": { + "description": "An error response received from the Scanning Service", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "ClassificationRules_Delete": { + "$ref": "./examples/ClassificationRules_Delete.json" + } + } + } + }, + "/classificationrules": { + "get": { + "tags": [ + "ClassificationRules" + ], + "description": "List classification rules in Account", + "operationId": "ClassificationRules_ListAll", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ClassificationRuleList" + } + }, + "default": { + "description": "An error response received from the Scanning Service", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "ClassificationRules_ListAll": { + "$ref": "./examples/ClassificationRules_ListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/classificationrules/{classificationRuleName}/versions": { + "get": { + "tags": [ + "ClassificationRules" + ], + "description": "Lists the rule versions of a classification rule", + "operationId": "ClassificationRules_ListVersionsByClassificationRuleName", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "classificationRuleName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ClassificationRuleList" + } + }, + "default": { + "description": "An error response received from the Scanning Service", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "ClassificationRules_ListVersionsByClassificationRuleName": { + "$ref": "./examples/ClassificationRules_ListVersionsByClassificationRuleName.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/classificationrules/{classificationRuleName}/versions/{classificationRuleVersion}/:tag": { + "post": { + "tags": [ + "ClassificationRules" + ], + "description": "Sets Classification Action on a specific classification rule version.", + "operationId": "ClassificationRules_TagClassificationVersion", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "classificationRuleName", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "classificationRuleVersion", + "required": true, + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "action", + "required": true, + "type": "string", + "enum": [ + "Keep", + "Delete" + ], + "x-ms-enum": { + "name": "ClassificationAction", + "modelAsString": true + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "202": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OperationResponse" + } + }, + "default": { + "description": "An error response received from the Scanning Service", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "ClassificationRules_TagClassificationVersion": { + "$ref": "./examples/ClassificationRules_TagClassificationVersion.json" + } + } + } + }, + "/datasources/{dataSourceName}": { + "put": { + "tags": [ + "DataSources" + ], + "description": "Creates or Updates a data source", + "operationId": "DataSources_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "dataSourceName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/DataSource" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DataSource" + } + }, + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DataSource" + } + }, + "default": { + "description": "An error response received from the Scanning Service", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "DataSources_CreateOrUpdate": { + "$ref": "./examples/DataSources_CreateOrUpdate.json" + } + } + }, + "get": { + "tags": [ + "DataSources" + ], + "description": "Get a data source", + "operationId": "DataSources_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "dataSourceName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DataSource" + } + }, + "default": { + "description": "An error response received from the Scanning Service", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "DataSources_Get": { + "$ref": "./examples/DataSources_Get.json" + } + } + }, + "delete": { + "tags": [ + "DataSources" + ], + "description": "Deletes a data source", + "operationId": "DataSources_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "dataSourceName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DataSource" + } + }, + "204": { + "description": "Success" + }, + "default": { + "description": "An error response received from the Scanning Service", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "DataSources_Delete": { + "$ref": "./examples/DataSources_Delete.json" + } + } + } + }, + "/datasources": { + "get": { + "tags": [ + "DataSources" + ], + "description": "List data sources in Data catalog", + "operationId": "DataSources_ListAll", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DataSourceList" + } + }, + "default": { + "description": "An error response received from the Scanning Service", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "DataSources_ListAll": { + "$ref": "./examples/DataSources_ListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/datasources/{dataSourceName}/scans/{scanName}/filters/custom": { + "get": { + "tags": [ + "Filters" + ], + "description": "Get a filter", + "operationId": "Filters_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "dataSourceName", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "scanName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Filter" + } + }, + "default": { + "description": "An error response received from the Scanning Service", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "Filters_Get": { + "$ref": "./examples/Filters_Get.json" + } + } + }, + "put": { + "tags": [ + "Filters" + ], + "description": "Creates or updates a filter", + "operationId": "Filters_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "dataSourceName", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "scanName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/Filter" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Filter" + } + }, + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Filter" + } + }, + "default": { + "description": "An error response received from the Scanning Service", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "Filters_CreateOrUpdate": { + "$ref": "./examples/Filters_CreateOrUpdate.json" + } + } + } + }, + "/datasources/{dataSourceName}/scans/{scanName}": { + "put": { + "tags": [ + "Scan" + ], + "description": "Creates an instance of a scan", + "operationId": "Scans_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "dataSourceName", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "scanName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Scan" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Scan" + } + }, + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Scan" + } + }, + "default": { + "description": "An error response received from the Scanning Service", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "Scans_CreateOrUpdate": { + "$ref": "./examples/Scans_CreateOrUpdate.json" + } + } + }, + "get": { + "tags": [ + "Scan" + ], + "description": "Gets a scan information", + "operationId": "Scans_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "dataSourceName", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "scanName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Scan" + } + }, + "default": { + "description": "An error response received from the Scanning Service", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "Scans_Get": { + "$ref": "./examples/Scans_Get.json" + } + } + }, + "delete": { + "tags": [ + "Scan" + ], + "description": "Deletes the scan associated with the data source", + "operationId": "Scans_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "dataSourceName", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "scanName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Scan" + } + }, + "204": { + "description": "Success" + }, + "default": { + "description": "An error response received from the Scanning Service", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "Scans_Delete": { + "$ref": "./examples/Scans_Delete.json" + } + } + } + }, + "/datasources/{dataSourceName}/scans": { + "get": { + "tags": [ + "Scan" + ], + "description": "List scans in data source", + "operationId": "Scans_ListByDataSource", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "dataSourceName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ScanList" + } + }, + "default": { + "description": "An error response received from the Scanning Service", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "Scans_ListByDataSource": { + "$ref": "./examples/Scans_ListByDataSource.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/datasources/{dataSourceName}/scans/{scanName}/runs/{runId}": { + "put": { + "tags": [ + "ScanResult" + ], + "description": "Runs the scan", + "operationId": "ScanResult_RunScan", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "dataSourceName", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "scanName", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "runId", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "scanLevel", + "type": "string", + "enum": [ + "Full", + "Incremental" + ], + "x-ms-enum": { + "name": "ScanLevelType", + "modelAsString": true + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "202": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OperationResponse" + } + }, + "default": { + "description": "An error response received from the Scanning Service", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "ScanResult_RunScan": { + "$ref": "./examples/ScanResult_RunScan.json" + } + } + } + }, + "/datasources/{dataSourceName}/scans/{scanName}/runs/{runId}/:cancel": { + "post": { + "tags": [ + "ScanResult" + ], + "description": "Cancels a scan", + "operationId": "ScanResult_CancelScan", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "dataSourceName", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "scanName", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "runId", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "202": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OperationResponse" + } + }, + "default": { + "description": "An error response received from the Scanning Service", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "ScanResult_CancelScan": { + "$ref": "./examples/ScanResult_CancelScan.json" + } + } + } + }, + "/datasources/{dataSourceName}/scans/{scanName}/runs": { + "get": { + "tags": [ + "ScanResult" + ], + "description": "Lists the scan history of a scan", + "operationId": "ScanResult_ListScanHistory", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "dataSourceName", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "scanName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ScanHistoryList" + } + }, + "default": { + "description": "An error response received from the Scanning Service", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "ScanResult_ListScanHistory": { + "$ref": "./examples/ScanResult_ListScanHistory.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/scanrulesets/{scanRulesetName}": { + "get": { + "tags": [ + "ScanRulesets" + ], + "description": "Get a scan ruleset", + "operationId": "ScanRulesets_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "scanRulesetName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ScanRuleset" + } + }, + "default": { + "description": "An error response received from the Scanning Service", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "ScanRulesets_Get": { + "$ref": "./examples/ScanRulesets_Get.json" + } + } + }, + "put": { + "tags": [ + "ScanRulesets" + ], + "description": "Creates or Updates a scan ruleset", + "operationId": "ScanRulesets_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "scanRulesetName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/ScanRuleset" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ScanRuleset" + } + }, + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ScanRuleset" + } + }, + "default": { + "description": "An error response received from the Scanning Service", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "ScanRulesets_CreateOrUpdate": { + "$ref": "./examples/ScanRulesets_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "ScanRulesets" + ], + "description": "Deletes a scan ruleset", + "operationId": "ScanRulesets_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "scanRulesetName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ScanRuleset" + } + }, + "204": { + "description": "Success" + }, + "default": { + "description": "An error response received from the Scanning Service", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "ScanRulesets_Delete": { + "$ref": "./examples/ScanRulesets_Delete.json" + } + } + } + }, + "/scanrulesets": { + "get": { + "tags": [ + "ScanRulesets" + ], + "description": "List scan rulesets in Data catalog", + "operationId": "ScanRulesets_ListAll", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ScanRulesetList" + } + }, + "default": { + "description": "An error response received from the Scanning Service", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "ScanRulesets_ListAll": { + "$ref": "./examples/ScanRulesets_ListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/systemScanRulesets": { + "get": { + "tags": [ + "SystemScanRulesets" + ], + "description": "List all system scan rulesets for an account", + "operationId": "SystemScanRulesets_ListAll", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SystemScanRulesetList" + } + }, + "default": { + "description": "An error response received from the Scanning Service", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "SystemScanRulesets_ListAll": { + "$ref": "./examples/SystemScanRulesets_ListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/systemScanRulesets/datasources/{dataSourceType}": { + "get": { + "tags": [ + "SystemScanRulesets" + ], + "description": "Get a system scan ruleset for a data source", + "operationId": "SystemScanRulesets_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "dataSourceType", + "required": true, + "type": "string", + "enum": [ + "None", + "AzureSubscription", + "AzureResourceGroup", + "AzureSynapseWorkspace", + "AzureSynapse", + "AdlsGen1", + "AdlsGen2", + "AmazonAccount", + "AmazonS3", + "AmazonSql", + "AzureCosmosDb", + "AzureDataExplorer", + "AzureFileService", + "AzureSqlDatabase", + "AmazonPostgreSql", + "AzurePostgreSql", + "SqlServerDatabase", + "AzureSqlDatabaseManagedInstance", + "AzureSqlDataWarehouse", + "AzureMySql", + "AzureStorage", + "Teradata", + "Oracle", + "SapS4Hana", + "SapEcc", + "PowerBI" + ], + "x-ms-enum": { + "name": "DataSourceType", + "modelAsString": true + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SystemScanRuleset" + } + }, + "default": { + "description": "An error response received from the Scanning Service", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "SystemScanRulesets_Get": { + "$ref": "./examples/SystemScanRulesets_Get.json" + } + } + } + }, + "/systemScanRulesets/versions/{version}": { + "get": { + "tags": [ + "SystemScanRulesets" + ], + "description": "Get a scan ruleset by version", + "operationId": "SystemScanRulesets_GetByVersion", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "dataSourceType", + "type": "string", + "enum": [ + "None", + "AzureSubscription", + "AzureResourceGroup", + "AzureSynapseWorkspace", + "AzureSynapse", + "AdlsGen1", + "AdlsGen2", + "AmazonAccount", + "AmazonS3", + "AmazonSql", + "AzureCosmosDb", + "AzureDataExplorer", + "AzureFileService", + "AzureSqlDatabase", + "AmazonPostgreSql", + "AzurePostgreSql", + "SqlServerDatabase", + "AzureSqlDatabaseManagedInstance", + "AzureSqlDataWarehouse", + "AzureMySql", + "AzureStorage", + "Teradata", + "Oracle", + "SapS4Hana", + "SapEcc", + "PowerBI" + ], + "x-ms-enum": { + "name": "DataSourceType", + "modelAsString": true + } + }, + { + "in": "path", + "name": "version", + "required": true, + "type": "integer", + "format": "int32" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SystemScanRuleset" + } + }, + "default": { + "description": "An error response received from the Scanning Service", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "SystemScanRulesets_GetByVersion": { + "$ref": "./examples/SystemScanRulesets_GetByVersion.json" + } + } + } + }, + "/systemScanRulesets/versions/latest": { + "get": { + "tags": [ + "SystemScanRulesets" + ], + "description": "Get the latest version of a system scan ruleset", + "operationId": "SystemScanRulesets_GetLatest", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "dataSourceType", + "type": "string", + "enum": [ + "None", + "AzureSubscription", + "AzureResourceGroup", + "AzureSynapseWorkspace", + "AzureSynapse", + "AdlsGen1", + "AdlsGen2", + "AmazonAccount", + "AmazonS3", + "AmazonSql", + "AzureCosmosDb", + "AzureDataExplorer", + "AzureFileService", + "AzureSqlDatabase", + "AmazonPostgreSql", + "AzurePostgreSql", + "SqlServerDatabase", + "AzureSqlDatabaseManagedInstance", + "AzureSqlDataWarehouse", + "AzureMySql", + "AzureStorage", + "Teradata", + "Oracle", + "SapS4Hana", + "SapEcc", + "PowerBI" + ], + "x-ms-enum": { + "name": "DataSourceType", + "modelAsString": true + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SystemScanRuleset" + } + }, + "default": { + "description": "An error response received from the Scanning Service", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "SystemScanRulesets_GetLatest": { + "$ref": "./examples/SystemScanRulesets_GetLatest.json" + } + } + } + }, + "/systemScanRulesets/versions": { + "get": { + "tags": [ + "SystemScanRulesets" + ], + "description": "List system scan ruleset versions in Data catalog", + "operationId": "SystemScanRulesets_ListVersionsByDataSource", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "dataSourceType", + "type": "string", + "enum": [ + "None", + "AzureSubscription", + "AzureResourceGroup", + "AzureSynapseWorkspace", + "AzureSynapse", + "AdlsGen1", + "AdlsGen2", + "AmazonAccount", + "AmazonS3", + "AmazonSql", + "AzureCosmosDb", + "AzureDataExplorer", + "AzureFileService", + "AzureSqlDatabase", + "AmazonPostgreSql", + "AzurePostgreSql", + "SqlServerDatabase", + "AzureSqlDatabaseManagedInstance", + "AzureSqlDataWarehouse", + "AzureMySql", + "AzureStorage", + "Teradata", + "Oracle", + "SapS4Hana", + "SapEcc", + "PowerBI" + ], + "x-ms-enum": { + "name": "DataSourceType", + "modelAsString": true + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SystemScanRulesetList" + } + }, + "default": { + "description": "An error response received from the Scanning Service", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "SystemScanRulesets_ListVersionsByDataSource": { + "$ref": "./examples/SystemScanRulesets_ListVersionsByDataSource.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/datasources/{dataSourceName}/scans/{scanName}/triggers/default": { + "get": { + "tags": [ + "Triggers" + ], + "description": "Gets trigger information", + "operationId": "Triggers_GetTrigger", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "dataSourceName", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "scanName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Trigger" + } + }, + "default": { + "description": "An error response received from the Scanning Service", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "Triggers_GetTrigger": { + "$ref": "./examples/Triggers_GetTrigger.json" + } + } + }, + "put": { + "tags": [ + "Triggers" + ], + "description": "Creates an instance of a trigger", + "operationId": "Triggers_CreateTrigger", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "dataSourceName", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "scanName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Trigger" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Trigger" + } + }, + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Trigger" + } + }, + "default": { + "description": "An error response received from the Scanning Service", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "Triggers_CreateTrigger": { + "$ref": "./examples/Triggers_CreateTrigger.json" + } + } + }, + "delete": { + "tags": [ + "Triggers" + ], + "description": "Deletes the trigger associated with the scan", + "operationId": "Triggers_DeleteTrigger", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "dataSourceName", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "scanName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Trigger" + } + }, + "204": { + "description": "Success" + }, + "default": { + "description": "An error response received from the Scanning Service", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "Triggers_DeleteTrigger": { + "$ref": "./examples/Triggers_DeleteTrigger.json" + } + } + } + } + }, + "definitions": { + "AzureKeyVaultProperties": { + "type": "object", + "properties": { + "baseUrl": { + "type": "string" + }, + "description": { + "type": "string" + } + } + }, + "ProxyResource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "readOnly": true + }, + "name": { + "type": "string", + "readOnly": true + } + } + }, + "AzureKeyVault": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureKeyVaultProperties" + } + ] + } + } + }, + "ErrorModel": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "target": { + "type": "string" + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "ErrorResponseModel": { + "type": "object", + "properties": { + "error": { + "allOf": [ + { + "$ref": "#/definitions/ErrorModel" + } + ] + } + } + }, + "AzureKeyVaultList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureKeyVault" + } + }, + "nextLink": { + "type": "string" + }, + "count": { + "format": "int64", + "type": "integer" + } + } + }, + "ClassificationRule": { + "required": [ + "kind" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "kind": { + "enum": [ + "System", + "Custom" + ], + "type": "string", + "x-ms-enum": { + "name": "ClassificationRuleType", + "modelAsString": true + } + } + }, + "discriminator": "kind" + }, + "ClassificationRuleList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ClassificationRule" + } + }, + "nextLink": { + "type": "string" + }, + "count": { + "format": "int64", + "type": "integer" + } + } + }, + "ErrorInfo": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "target": { + "type": "string" + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ErrorInfo" + } + } + } + }, + "OperationResponse": { + "type": "object", + "properties": { + "scanResultId": { + "format": "uuid", + "type": "string" + }, + "startTime": { + "format": "date-time", + "type": "string" + }, + "endTime": { + "format": "date-time", + "type": "string" + }, + "status": { + "enum": [ + "Accepted", + "InProgress", + "TransientFailure", + "Succeeded", + "Failed", + "Canceled" + ], + "type": "string", + "x-ms-enum": { + "name": "OperationStatus", + "modelAsString": true + } + }, + "error": { + "allOf": [ + { + "$ref": "#/definitions/ErrorInfo" + } + ] + } + } + }, + "Notification": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "code": { + "format": "int32", + "type": "integer" + } + } + }, + "ScanDiagnostics": { + "type": "object", + "properties": { + "notifications": { + "type": "array", + "items": { + "$ref": "#/definitions/Notification" + } + }, + "exceptionCountMap": { + "type": "object", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + } + } + }, + "ScanResult": { + "type": "object", + "properties": { + "parentId": { + "type": "string", + "readOnly": true + }, + "id": { + "type": "string", + "readOnly": true + }, + "resourceId": { + "type": "string", + "readOnly": true + }, + "status": { + "type": "string", + "readOnly": true + }, + "assetsDiscovered": { + "format": "int64", + "type": "integer", + "readOnly": true + }, + "assetsClassified": { + "format": "int64", + "type": "integer", + "readOnly": true + }, + "diagnostics": { + "allOf": [ + { + "$ref": "#/definitions/ScanDiagnostics" + } + ], + "readOnly": true + }, + "startTime": { + "format": "date-time", + "type": "string", + "readOnly": true + }, + "queuedTime": { + "format": "date-time", + "type": "string", + "readOnly": true + }, + "pipelineStartTime": { + "format": "date-time", + "type": "string", + "readOnly": true + }, + "endTime": { + "format": "date-time", + "type": "string", + "readOnly": true + }, + "scanRulesetVersion": { + "format": "int32", + "type": "integer", + "readOnly": true + }, + "scanRulesetType": { + "enum": [ + "Custom", + "System" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ScanRulesetType", + "modelAsString": true + } + }, + "scanLevelType": { + "enum": [ + "Full", + "Incremental" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ScanLevelType", + "modelAsString": true + } + }, + "errorMessage": { + "type": "string", + "readOnly": true + }, + "error": { + "allOf": [ + { + "$ref": "#/definitions/ErrorModel" + } + ], + "readOnly": true + }, + "runType": { + "type": "string", + "readOnly": true + }, + "dataSourceType": { + "enum": [ + "None", + "AzureSubscription", + "AzureResourceGroup", + "AzureSynapseWorkspace", + "AzureSynapse", + "AdlsGen1", + "AdlsGen2", + "AmazonAccount", + "AmazonS3", + "AmazonSql", + "AzureCosmosDb", + "AzureDataExplorer", + "AzureFileService", + "AzureSqlDatabase", + "AmazonPostgreSql", + "AzurePostgreSql", + "SqlServerDatabase", + "AzureSqlDatabaseManagedInstance", + "AzureSqlDataWarehouse", + "AzureMySql", + "AzureStorage", + "Teradata", + "Oracle", + "SapS4Hana", + "SapEcc", + "PowerBI" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DataSourceType", + "modelAsString": true + } + } + } + }, + "Scan": { + "required": [ + "kind" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "kind": { + "enum": [ + "AzureSubscriptionCredential", + "AzureSubscriptionMsi", + "AzureResourceGroupCredential", + "AzureResourceGroupMsi", + "AzureSynapseWorkspaceCredential", + "AzureSynapseWorkspaceMsi", + "AzureSynapseCredential", + "AzureSynapseMsi", + "AdlsGen1Credential", + "AdlsGen1Msi", + "AdlsGen2Credential", + "AdlsGen2Msi", + "AmazonAccountCredential", + "AmazonS3Credential", + "AmazonS3RoleARN", + "AmazonSqlCredential", + "AzureCosmosDbCredential", + "AzureDataExplorerCredential", + "AzureDataExplorerMsi", + "AzureFileServiceCredential", + "AzureSqlDatabaseCredential", + "AzureSqlDatabaseMsi", + "AmazonPostgreSqlCredential", + "AmazonPostgreSqlRoleARN", + "AzurePostgreSqlCredential", + "SqlServerDatabaseCredential", + "AzureSqlDatabaseManagedInstanceCredential", + "AzureSqlDatabaseManagedInstanceMsi", + "AzureSqlDataWarehouseCredential", + "AzureSqlDataWarehouseMsi", + "AzureMySqlCredential", + "AzureStorageCredential", + "AzureStorageMsi", + "TeradataTeradataCredential", + "TeradataTeradataUserPass", + "TeradataUserPass", + "OracleOracleCredential", + "OracleOracleUserPass", + "SapS4HanaSapS4HanaCredential", + "SapS4HanaSapS4HanaUserPass", + "SapEccSapEccCredential", + "SapEccSapEccUserPass", + "PowerBIDelegated", + "PowerBIMsi" + ], + "type": "string", + "x-ms-enum": { + "name": "ScanAuthorizationType", + "modelAsString": true + } + }, + "scanResults": { + "type": "array", + "items": { + "$ref": "#/definitions/ScanResult" + }, + "readOnly": true + } + }, + "discriminator": "kind" + }, + "DataSource": { + "required": [ + "kind" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "kind": { + "enum": [ + "None", + "AzureSubscription", + "AzureResourceGroup", + "AzureSynapseWorkspace", + "AzureSynapse", + "AdlsGen1", + "AdlsGen2", + "AmazonAccount", + "AmazonS3", + "AmazonSql", + "AzureCosmosDb", + "AzureDataExplorer", + "AzureFileService", + "AzureSqlDatabase", + "AmazonPostgreSql", + "AzurePostgreSql", + "SqlServerDatabase", + "AzureSqlDatabaseManagedInstance", + "AzureSqlDataWarehouse", + "AzureMySql", + "AzureStorage", + "Teradata", + "Oracle", + "SapS4Hana", + "SapEcc", + "PowerBI" + ], + "type": "string", + "x-ms-enum": { + "name": "DataSourceType", + "modelAsString": true + } + }, + "scans": { + "type": "array", + "items": { + "$ref": "#/definitions/Scan" + }, + "readOnly": true + } + }, + "discriminator": "kind" + }, + "DataSourceList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DataSource" + } + }, + "nextLink": { + "type": "string" + }, + "count": { + "format": "int64", + "type": "integer" + } + } + }, + "FilterProperties": { + "type": "object", + "properties": { + "excludeUriPrefixes": { + "uniqueItems": true, + "type": "array", + "items": { + "type": "string" + } + }, + "includeUriPrefixes": { + "uniqueItems": true, + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "Filter": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/FilterProperties" + } + ] + } + } + }, + "ScanList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Scan" + } + }, + "nextLink": { + "type": "string" + }, + "count": { + "format": "int64", + "type": "integer" + } + } + }, + "ScanHistoryList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ScanResult" + } + }, + "nextLink": { + "type": "string" + }, + "count": { + "format": "int64", + "type": "integer" + } + } + }, + "VersionedScanRuleset": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "scanRulesetType": { + "enum": [ + "Custom", + "System" + ], + "type": "string", + "x-ms-enum": { + "name": "ScanRulesetType", + "modelAsString": true + } + }, + "status": { + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ScanRulesetStatus", + "modelAsString": true + } + }, + "version": { + "format": "int32", + "type": "integer", + "readOnly": true + } + } + }, + "ScanRuleset": { + "required": [ + "kind" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/VersionedScanRuleset" + } + ], + "properties": { + "kind": { + "enum": [ + "None", + "AzureSubscription", + "AzureResourceGroup", + "AzureSynapseWorkspace", + "AzureSynapse", + "AdlsGen1", + "AdlsGen2", + "AmazonAccount", + "AmazonS3", + "AmazonSql", + "AzureCosmosDb", + "AzureDataExplorer", + "AzureFileService", + "AzureSqlDatabase", + "AmazonPostgreSql", + "AzurePostgreSql", + "SqlServerDatabase", + "AzureSqlDatabaseManagedInstance", + "AzureSqlDataWarehouse", + "AzureMySql", + "AzureStorage", + "Teradata", + "Oracle", + "SapS4Hana", + "SapEcc", + "PowerBI" + ], + "type": "string", + "x-ms-enum": { + "name": "DataSourceType", + "modelAsString": true + } + } + }, + "discriminator": "kind" + }, + "ScanRulesetList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ScanRuleset" + } + }, + "nextLink": { + "type": "string" + }, + "count": { + "format": "int64", + "type": "integer" + } + } + }, + "SystemScanRuleset": { + "required": [ + "kind" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/VersionedScanRuleset" + } + ], + "properties": { + "kind": { + "enum": [ + "None", + "AzureSubscription", + "AzureResourceGroup", + "AzureSynapseWorkspace", + "AzureSynapse", + "AdlsGen1", + "AdlsGen2", + "AmazonAccount", + "AmazonS3", + "AmazonSql", + "AzureCosmosDb", + "AzureDataExplorer", + "AzureFileService", + "AzureSqlDatabase", + "AmazonPostgreSql", + "AzurePostgreSql", + "SqlServerDatabase", + "AzureSqlDatabaseManagedInstance", + "AzureSqlDataWarehouse", + "AzureMySql", + "AzureStorage", + "Teradata", + "Oracle", + "SapS4Hana", + "SapEcc", + "PowerBI" + ], + "type": "string", + "x-ms-enum": { + "name": "DataSourceType", + "modelAsString": true + } + } + }, + "discriminator": "kind" + }, + "SystemScanRulesetList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SystemScanRuleset" + } + }, + "nextLink": { + "type": "string" + }, + "count": { + "format": "int64", + "type": "integer" + } + } + }, + "RecurrenceScheduleOccurrence": { + "type": "object", + "properties": { + "additionalProperties": { + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "day": { + "enum": [ + "Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday" + ], + "type": "string", + "x-ms-enum": { + "name": "DayOfWeek", + "modelAsString": true + } + }, + "occurrence": { + "format": "int32", + "type": "integer" + } + } + }, + "RecurrenceSchedule": { + "type": "object", + "properties": { + "additionalProperties": { + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "minutes": { + "type": "array", + "items": { + "format": "int32", + "type": "integer" + } + }, + "hours": { + "type": "array", + "items": { + "format": "int32", + "type": "integer" + } + }, + "weekDays": { + "type": "array", + "items": { + "enum": [ + "Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday" + ], + "type": "string", + "x-ms-enum": { + "name": "DaysOfWeek", + "modelAsString": true + } + } + }, + "monthDays": { + "type": "array", + "items": { + "format": "int32", + "type": "integer" + } + }, + "monthlyOccurrences": { + "type": "array", + "items": { + "$ref": "#/definitions/RecurrenceScheduleOccurrence" + } + } + } + }, + "TriggerRecurrence": { + "type": "object", + "properties": { + "frequency": { + "enum": [ + "Week", + "Month" + ], + "type": "string", + "x-ms-enum": { + "name": "TriggerFrequency", + "modelAsString": true + } + }, + "interval": { + "format": "int32", + "type": "integer" + }, + "startTime": { + "format": "date-time", + "type": "string" + }, + "endTime": { + "format": "date-time", + "type": "string" + }, + "schedule": { + "allOf": [ + { + "$ref": "#/definitions/RecurrenceSchedule" + } + ] + }, + "timeZone": { + "type": "string" + } + } + }, + "TriggerProperties": { + "type": "object", + "properties": { + "recurrence": { + "allOf": [ + { + "$ref": "#/definitions/TriggerRecurrence" + } + ] + }, + "recurrenceInterval": { + "type": "string" + }, + "createdAt": { + "format": "date-time", + "type": "string", + "readOnly": true + }, + "lastModifiedAt": { + "format": "date-time", + "type": "string", + "readOnly": true + }, + "lastScheduled": { + "format": "date-time", + "type": "string", + "readOnly": true + }, + "scanLevel": { + "enum": [ + "Full", + "Incremental" + ], + "type": "string", + "x-ms-enum": { + "name": "ScanLevelType", + "modelAsString": true + } + }, + "incrementalScanStartTime": { + "format": "date-time", + "type": "string" + } + } + }, + "Trigger": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/TriggerProperties" + } + ] + } + } + }, + "CollectionReference": { + "type": "object", + "properties": { + "lastModifiedAt": { + "format": "date-time", + "type": "string", + "readOnly": true + }, + "referenceName": { + "type": "string" + }, + "type": { + "type": "string" + } + } + }, + "SystemClassificationRuleProperties": { + "type": "object", + "properties": { + "description": { + "type": "string" + }, + "version": { + "format": "int32", + "type": "integer", + "readOnly": true + }, + "classificationName": { + "type": "string" + }, + "ruleStatus": { + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "ClassificationRuleStatus", + "modelAsString": true + } + }, + "createdAt": { + "format": "date-time", + "type": "string", + "readOnly": true + }, + "lastModifiedAt": { + "format": "date-time", + "type": "string", + "readOnly": true + } + } + }, + "SystemClassificationRule": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ClassificationRule" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/SystemClassificationRuleProperties" + } + ] + } + }, + "x-ms-discriminator-value": "System" + }, + "ClassificationRulePattern": { + "required": [ + "kind" + ], + "type": "object", + "properties": { + "kind": { + "enum": [ + "Regex" + ], + "type": "string", + "x-ms-enum": { + "name": "ClassificationRulePatternType", + "modelAsString": true + } + } + }, + "discriminator": "kind" + }, + "CustomClassificationRuleProperties": { + "type": "object", + "properties": { + "minimumPercentageMatch": { + "format": "double", + "type": "number" + }, + "classificationAction": { + "enum": [ + "Keep", + "Delete" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ClassificationAction", + "modelAsString": true + } + }, + "dataPatterns": { + "type": "array", + "items": { + "$ref": "#/definitions/ClassificationRulePattern" + } + }, + "columnPatterns": { + "type": "array", + "items": { + "$ref": "#/definitions/ClassificationRulePattern" + } + }, + "description": { + "type": "string" + }, + "version": { + "format": "int32", + "type": "integer", + "readOnly": true + }, + "classificationName": { + "type": "string" + }, + "ruleStatus": { + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "ClassificationRuleStatus", + "modelAsString": true + } + }, + "createdAt": { + "format": "date-time", + "type": "string", + "readOnly": true + }, + "lastModifiedAt": { + "format": "date-time", + "type": "string", + "readOnly": true + } + } + }, + "CustomClassificationRule": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ClassificationRule" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/CustomClassificationRuleProperties" + } + ] + } + }, + "x-ms-discriminator-value": "Custom" + }, + "RegexClassificationRulePattern": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ClassificationRulePattern" + } + ], + "properties": { + "pattern": { + "type": "string" + } + }, + "x-ms-discriminator-value": "Regex" + }, + "DataSourceProperties": { + "type": "object", + "properties": { + "createdAt": { + "format": "date-time", + "type": "string", + "readOnly": true + }, + "lastModifiedAt": { + "format": "date-time", + "type": "string", + "readOnly": true + }, + "collection": { + "allOf": [ + { + "$ref": "#/definitions/CollectionReference" + } + ] + } + } + }, + "AzureSubscriptionProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataSourceProperties" + } + ], + "properties": { + "subscriptionId": { + "type": "string" + } + } + }, + "AzureSubscriptionDataSource": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataSource" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureSubscriptionProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AzureSubscription" + }, + "AzureResourceGroupProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataSourceProperties" + } + ], + "properties": { + "subscriptionId": { + "type": "string" + }, + "resourceGroup": { + "type": "string" + } + } + }, + "AzureResourceGroupDataSource": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataSource" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureResourceGroupProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AzureResourceGroup" + }, + "AzureDataSourceProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataSourceProperties" + } + ], + "properties": { + "resourceGroup": { + "type": "string" + }, + "subscriptionId": { + "type": "string" + }, + "location": { + "type": "string" + }, + "resourceName": { + "type": "string" + } + } + }, + "AzureSynapseWorkspaceProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureDataSourceProperties" + } + ], + "properties": { + "dedicatedSqlEndpoint": { + "type": "string" + }, + "serverlessSqlEndpoint": { + "type": "string" + } + } + }, + "AzureSynapseWorkspaceDataSource": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataSource" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureSynapseWorkspaceProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AzureSynapseWorkspace" + }, + "AzureSynapseProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureDataSourceProperties" + } + ], + "properties": { + "sqlEndpoint": { + "type": "string" + }, + "sqlOnDemandEndpoint": { + "type": "string" + } + } + }, + "AzureSynapseDataSource": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataSource" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureSynapseProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AzureSynapse" + }, + "AdlsGen1Properties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureDataSourceProperties" + } + ], + "properties": { + "endpoint": { + "type": "string" + } + } + }, + "AdlsGen1DataSource": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataSource" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AdlsGen1Properties" + } + ] + } + }, + "x-ms-discriminator-value": "AdlsGen1" + }, + "AdlsGen2Properties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureDataSourceProperties" + } + ], + "properties": { + "endpoint": { + "type": "string" + } + } + }, + "AdlsGen2DataSource": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataSource" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AdlsGen2Properties" + } + ] + } + }, + "x-ms-discriminator-value": "AdlsGen2" + }, + "AmazonAccountProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataSourceProperties" + } + ], + "properties": { + "awsAccountId": { + "type": "string" + }, + "roleARN": { + "type": "string" + } + } + }, + "AmazonAccountDataSource": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataSource" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AmazonAccountProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AmazonAccount" + }, + "AmazonS3Properties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataSourceProperties" + } + ], + "properties": { + "serviceUrl": { + "type": "string" + }, + "roleARN": { + "type": "string" + } + } + }, + "AmazonS3DataSource": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataSource" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AmazonS3Properties" + } + ] + } + }, + "x-ms-discriminator-value": "AmazonS3" + }, + "AmazonSqlProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataSourceProperties" + } + ], + "properties": { + "serverEndpoint": { + "type": "string" + }, + "port": { + "format": "int32", + "type": "integer" + }, + "vpcEndpointServiceName": { + "type": "string" + } + } + }, + "AmazonSqlDataSource": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataSource" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AmazonSqlProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AmazonSql" + }, + "AzureCosmosDbProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureDataSourceProperties" + } + ], + "properties": { + "accountUri": { + "type": "string" + } + } + }, + "AzureCosmosDbDataSource": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataSource" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureCosmosDbProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AzureCosmosDb" + }, + "AzureDataExplorerProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureDataSourceProperties" + } + ], + "properties": { + "endpoint": { + "type": "string" + } + } + }, + "AzureDataExplorerDataSource": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataSource" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureDataExplorerProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AzureDataExplorer" + }, + "AzureFileServiceProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureDataSourceProperties" + } + ], + "properties": { + "endpoint": { + "type": "string" + } + } + }, + "AzureFileServiceDataSource": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataSource" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureFileServiceProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AzureFileService" + }, + "AzureSqlDatabaseProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureDataSourceProperties" + } + ], + "properties": { + "serverEndpoint": { + "type": "string" + } + } + }, + "AzureSqlDatabaseDataSource": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataSource" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureSqlDatabaseProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AzureSqlDatabase" + }, + "AmazonPostgreSqlProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataSourceProperties" + } + ], + "properties": { + "serverEndpoint": { + "type": "string" + }, + "port": { + "format": "int32", + "type": "integer" + }, + "vpcEndpointServiceName": { + "type": "string" + } + } + }, + "AmazonPostgreSqlDataSource": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataSource" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AmazonPostgreSqlProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AmazonPostgreSql" + }, + "AzurePostgreSqlProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureDataSourceProperties" + } + ], + "properties": { + "serverEndpoint": { + "type": "string" + }, + "port": { + "format": "int32", + "type": "integer" + } + } + }, + "AzurePostgreSqlDataSource": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataSource" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzurePostgreSqlProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AzurePostgreSql" + }, + "SqlServerDatabaseProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureDataSourceProperties" + } + ], + "properties": { + "serverEndpoint": { + "type": "string" + } + } + }, + "SqlServerDatabaseDataSource": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataSource" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/SqlServerDatabaseProperties" + } + ] + } + }, + "x-ms-discriminator-value": "SqlServerDatabase" + }, + "AzureSqlDatabaseManagedInstanceProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureDataSourceProperties" + } + ], + "properties": { + "serverEndpoint": { + "type": "string" + } + } + }, + "AzureSqlDatabaseManagedInstanceDataSource": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataSource" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureSqlDatabaseManagedInstanceProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AzureSqlDatabaseManagedInstance" + }, + "AzureSqlDataWarehouseProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureDataSourceProperties" + } + ], + "properties": { + "serverEndpoint": { + "type": "string" + } + } + }, + "AzureSqlDataWarehouseDataSource": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataSource" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureSqlDataWarehouseProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AzureSqlDataWarehouse" + }, + "AzureMySqlProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureDataSourceProperties" + } + ], + "properties": { + "serverEndpoint": { + "type": "string" + }, + "port": { + "format": "int32", + "type": "integer" + } + } + }, + "AzureMySqlDataSource": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataSource" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureMySqlProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AzureMySql" + }, + "AzureStorageProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureDataSourceProperties" + } + ], + "properties": { + "endpoint": { + "type": "string" + } + } + }, + "AzureStorageDataSource": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataSource" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureStorageProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AzureStorage" + }, + "TeradataProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataSourceProperties" + } + ], + "properties": { + "host": { + "type": "string" + } + } + }, + "TeradataDataSource": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataSource" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/TeradataProperties" + } + ] + } + }, + "x-ms-discriminator-value": "Teradata" + }, + "OracleProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataSourceProperties" + } + ], + "properties": { + "host": { + "type": "string" + }, + "port": { + "type": "string" + }, + "service": { + "type": "string" + } + } + }, + "OracleDataSource": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataSource" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/OracleProperties" + } + ] + } + }, + "x-ms-discriminator-value": "Oracle" + }, + "SapS4HanaProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataSourceProperties" + } + ], + "properties": { + "applicationServer": { + "type": "string" + }, + "systemNumber": { + "type": "string" + } + } + }, + "SapS4HanaDataSource": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataSource" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/SapS4HanaProperties" + } + ] + } + }, + "x-ms-discriminator-value": "SapS4Hana" + }, + "SapEccProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataSourceProperties" + } + ], + "properties": { + "applicationServer": { + "type": "string" + }, + "systemNumber": { + "type": "string" + } + } + }, + "SapEccDataSource": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataSource" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/SapEccProperties" + } + ] + } + }, + "x-ms-discriminator-value": "SapEcc" + }, + "PowerBIProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataSourceProperties" + } + ], + "properties": { + "tenant": { + "type": "string" + } + } + }, + "PowerBIDataSource": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataSource" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/PowerBIProperties" + } + ] + } + }, + "x-ms-discriminator-value": "PowerBI" + }, + "ScanRulesetProperties": { + "type": "object", + "properties": { + "createdAt": { + "format": "date-time", + "type": "string", + "readOnly": true + }, + "description": { + "type": "string" + }, + "excludedSystemClassifications": { + "uniqueItems": true, + "type": "array", + "items": { + "type": "string" + } + }, + "includedCustomClassificationRuleNames": { + "uniqueItems": true, + "type": "array", + "items": { + "type": "string" + } + }, + "lastModifiedAt": { + "format": "date-time", + "type": "string", + "readOnly": true + } + } + }, + "AzureSubscriptionScanRulesetProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanRulesetProperties" + } + ] + }, + "AzureSubscriptionScanRuleset": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanRuleset" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureSubscriptionScanRulesetProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AzureSubscription" + }, + "AzureResourceGroupScanRulesetProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanRulesetProperties" + } + ] + }, + "AzureResourceGroupScanRuleset": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanRuleset" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureResourceGroupScanRulesetProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AzureResourceGroup" + }, + "AzureSynapseWorkspaceScanRulesetProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanRulesetProperties" + } + ] + }, + "AzureSynapseWorkspaceScanRuleset": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanRuleset" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureSynapseWorkspaceScanRulesetProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AzureSynapseWorkspace" + }, + "AzureSynapseScanRulesetProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanRulesetProperties" + } + ] + }, + "AzureSynapseScanRuleset": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanRuleset" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureSynapseScanRulesetProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AzureSynapse" + }, + "CustomFileType": { + "type": "object", + "properties": { + "builtInType": { + "enum": [ + "AVRO", + "ORC", + "PARQUET", + "JSON", + "TXT", + "XML", + "Documents", + "CSV", + "PSV", + "SSV", + "TSV", + "GZ", + "DOC", + "DOCM", + "DOCX", + "DOT", + "ODP", + "ODS", + "ODT", + "PDF", + "POT", + "PPS", + "PPSX", + "PPT", + "PPTM", + "PPTX", + "XLC", + "XLS", + "XLSB", + "XLSM", + "XLSX", + "XLT" + ], + "type": "string", + "x-ms-enum": { + "name": "FileExtensionsType", + "modelAsString": true + } + }, + "customDelimiter": { + "type": "string" + } + } + }, + "CustomFileExtension": { + "type": "object", + "properties": { + "customFileType": { + "allOf": [ + { + "$ref": "#/definitions/CustomFileType" + } + ] + }, + "description": { + "type": "string" + }, + "enabled": { + "type": "boolean" + }, + "fileExtension": { + "type": "string" + } + } + }, + "ScanningRule": { + "type": "object", + "properties": { + "fileExtensions": { + "uniqueItems": true, + "type": "array", + "items": { + "enum": [ + "AVRO", + "ORC", + "PARQUET", + "JSON", + "TXT", + "XML", + "Documents", + "CSV", + "PSV", + "SSV", + "TSV", + "GZ", + "DOC", + "DOCM", + "DOCX", + "DOT", + "ODP", + "ODS", + "ODT", + "PDF", + "POT", + "PPS", + "PPSX", + "PPT", + "PPTM", + "PPTX", + "XLC", + "XLS", + "XLSB", + "XLSM", + "XLSX", + "XLT" + ], + "type": "string", + "x-ms-enum": { + "name": "FileExtensionsType", + "modelAsString": true + } + } + }, + "customFileExtensions": { + "uniqueItems": true, + "type": "array", + "items": { + "$ref": "#/definitions/CustomFileExtension" + } + } + } + }, + "ScanningRuleScanRulesetProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanRulesetProperties" + } + ], + "properties": { + "scanningRule": { + "allOf": [ + { + "$ref": "#/definitions/ScanningRule" + } + ] + } + } + }, + "AdlsGen1ScanRulesetProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanningRuleScanRulesetProperties" + } + ] + }, + "AdlsGen1ScanRuleset": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanRuleset" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AdlsGen1ScanRulesetProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AdlsGen1" + }, + "AdlsGen2ScanRulesetProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanningRuleScanRulesetProperties" + } + ] + }, + "AdlsGen2ScanRuleset": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanRuleset" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AdlsGen2ScanRulesetProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AdlsGen2" + }, + "AmazonAccountScanRulesetProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanRulesetProperties" + } + ] + }, + "AmazonAccountScanRuleset": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanRuleset" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AmazonAccountScanRulesetProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AmazonAccount" + }, + "AmazonS3ScanRulesetProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanningRuleScanRulesetProperties" + } + ] + }, + "AmazonS3ScanRuleset": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanRuleset" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AmazonS3ScanRulesetProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AmazonS3" + }, + "AmazonSqlScanRulesetProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanRulesetProperties" + } + ] + }, + "AmazonSqlScanRuleset": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanRuleset" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AmazonSqlScanRulesetProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AmazonSql" + }, + "AzureCosmosDbScanRulesetProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanRulesetProperties" + } + ] + }, + "AzureCosmosDbScanRuleset": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanRuleset" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureCosmosDbScanRulesetProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AzureCosmosDb" + }, + "AzureDataExplorerScanRulesetProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanRulesetProperties" + } + ] + }, + "AzureDataExplorerScanRuleset": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanRuleset" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureDataExplorerScanRulesetProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AzureDataExplorer" + }, + "AzureFileServiceScanRulesetProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanningRuleScanRulesetProperties" + } + ] + }, + "AzureFileServiceScanRuleset": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanRuleset" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureFileServiceScanRulesetProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AzureFileService" + }, + "AzureSqlDatabaseScanRulesetProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanRulesetProperties" + } + ] + }, + "AzureSqlDatabaseScanRuleset": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanRuleset" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureSqlDatabaseScanRulesetProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AzureSqlDatabase" + }, + "AmazonPostgreSqlScanRulesetProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanRulesetProperties" + } + ] + }, + "AmazonPostgreSqlScanRuleset": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanRuleset" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AmazonPostgreSqlScanRulesetProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AmazonPostgreSql" + }, + "AzurePostgreSqlScanRulesetProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanRulesetProperties" + } + ] + }, + "AzurePostgreSqlScanRuleset": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanRuleset" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzurePostgreSqlScanRulesetProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AzurePostgreSql" + }, + "SqlServerDatabaseScanRulesetProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanRulesetProperties" + } + ] + }, + "SqlServerDatabaseScanRuleset": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanRuleset" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/SqlServerDatabaseScanRulesetProperties" + } + ] + } + }, + "x-ms-discriminator-value": "SqlServerDatabase" + }, + "AzureSqlDatabaseManagedInstanceScanRulesetProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanRulesetProperties" + } + ] + }, + "AzureSqlDatabaseManagedInstanceScanRuleset": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanRuleset" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureSqlDatabaseManagedInstanceScanRulesetProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AzureSqlDatabaseManagedInstance" + }, + "AzureSqlDataWarehouseScanRulesetProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanRulesetProperties" + } + ] + }, + "AzureSqlDataWarehouseScanRuleset": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanRuleset" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureSqlDataWarehouseScanRulesetProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AzureSqlDataWarehouse" + }, + "AzureMySqlScanRulesetProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanRulesetProperties" + } + ] + }, + "AzureMySqlScanRuleset": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanRuleset" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureMySqlScanRulesetProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AzureMySql" + }, + "AzureStorageScanRulesetProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanningRuleScanRulesetProperties" + } + ] + }, + "AzureStorageScanRuleset": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanRuleset" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureStorageScanRulesetProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AzureStorage" + }, + "TeradataScanRulesetProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanRulesetProperties" + } + ] + }, + "TeradataScanRuleset": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanRuleset" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/TeradataScanRulesetProperties" + } + ] + } + }, + "x-ms-discriminator-value": "Teradata" + }, + "OracleScanRulesetProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanRulesetProperties" + } + ] + }, + "OracleScanRuleset": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanRuleset" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/OracleScanRulesetProperties" + } + ] + } + }, + "x-ms-discriminator-value": "Oracle" + }, + "SapS4HanaScanRulesetProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanRulesetProperties" + } + ] + }, + "SapS4HanaScanRuleset": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanRuleset" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/SapS4HanaScanRulesetProperties" + } + ] + } + }, + "x-ms-discriminator-value": "SapS4Hana" + }, + "SapEccScanRulesetProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanRulesetProperties" + } + ] + }, + "SapEccScanRuleset": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanRuleset" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/SapEccScanRulesetProperties" + } + ] + } + }, + "x-ms-discriminator-value": "SapEcc" + }, + "PowerBIScanRulesetProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanRulesetProperties" + } + ] + }, + "PowerBIScanRuleset": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanRuleset" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/PowerBIScanRulesetProperties" + } + ] + } + }, + "x-ms-discriminator-value": "PowerBI" + }, + "ResourceNameFilter": { + "type": "object", + "properties": { + "excludePrefixes": { + "uniqueItems": true, + "type": "array", + "items": { + "type": "string" + } + }, + "includePrefixes": { + "uniqueItems": true, + "type": "array", + "items": { + "type": "string" + } + }, + "resources": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "CredentialReference": { + "type": "object", + "properties": { + "referenceName": { + "type": "string" + }, + "credentialType": { + "enum": [ + "AccountKey", + "ServicePrincipal", + "BasicAuth", + "SqlAuth", + "AmazonARN" + ], + "type": "string", + "x-ms-enum": { + "name": "CredentialType", + "modelAsString": true + } + } + } + }, + "ResourceTypeFilter": { + "type": "object", + "properties": { + "scanRulesetName": { + "type": "string" + }, + "scanRulesetType": { + "enum": [ + "Custom", + "System" + ], + "type": "string", + "x-ms-enum": { + "name": "ScanRulesetType", + "modelAsString": true + } + }, + "resourceNameFilter": { + "allOf": [ + { + "$ref": "#/definitions/ResourceNameFilter" + } + ] + }, + "credential": { + "allOf": [ + { + "$ref": "#/definitions/CredentialReference" + } + ] + } + } + }, + "ConnectedVia": { + "type": "object", + "properties": { + "referenceName": { + "type": "string" + } + } + }, + "ScanProperties": { + "type": "object", + "properties": { + "scanRulesetName": { + "type": "string" + }, + "scanRulesetType": { + "enum": [ + "Custom", + "System" + ], + "type": "string", + "x-ms-enum": { + "name": "ScanRulesetType", + "modelAsString": true + } + }, + "collection": { + "allOf": [ + { + "$ref": "#/definitions/CollectionReference" + } + ] + }, + "workers": { + "format": "int32", + "type": "integer" + }, + "createdAt": { + "format": "date-time", + "type": "string", + "readOnly": true + }, + "lastModifiedAt": { + "format": "date-time", + "type": "string", + "readOnly": true + }, + "connectedVia": { + "allOf": [ + { + "$ref": "#/definitions/ConnectedVia" + } + ] + } + } + }, + "ExpandingResourceScanProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanProperties" + } + ], + "properties": { + "resourceTypes": { + "type": "object", + "properties": { + "None": { + "$ref": "#/definitions/ResourceTypeFilter" + }, + "AzureSubscription": { + "$ref": "#/definitions/ResourceTypeFilter" + }, + "AzureResourceGroup": { + "$ref": "#/definitions/ResourceTypeFilter" + }, + "AzureSynapseWorkspace": { + "$ref": "#/definitions/ResourceTypeFilter" + }, + "AzureSynapse": { + "$ref": "#/definitions/ResourceTypeFilter" + }, + "AdlsGen1": { + "$ref": "#/definitions/ResourceTypeFilter" + }, + "AdlsGen2": { + "$ref": "#/definitions/ResourceTypeFilter" + }, + "AmazonAccount": { + "$ref": "#/definitions/ResourceTypeFilter" + }, + "AmazonS3": { + "$ref": "#/definitions/ResourceTypeFilter" + }, + "AmazonSql": { + "$ref": "#/definitions/ResourceTypeFilter" + }, + "AzureCosmosDb": { + "$ref": "#/definitions/ResourceTypeFilter" + }, + "AzureDataExplorer": { + "$ref": "#/definitions/ResourceTypeFilter" + }, + "AzureFileService": { + "$ref": "#/definitions/ResourceTypeFilter" + }, + "AzureSqlDatabase": { + "$ref": "#/definitions/ResourceTypeFilter" + }, + "AmazonPostgreSql": { + "$ref": "#/definitions/ResourceTypeFilter" + }, + "AzurePostgreSql": { + "$ref": "#/definitions/ResourceTypeFilter" + }, + "SqlServerDatabase": { + "$ref": "#/definitions/ResourceTypeFilter" + }, + "AzureSqlDatabaseManagedInstance": { + "$ref": "#/definitions/ResourceTypeFilter" + }, + "AzureSqlDataWarehouse": { + "$ref": "#/definitions/ResourceTypeFilter" + }, + "AzureMySql": { + "$ref": "#/definitions/ResourceTypeFilter" + }, + "AzureStorage": { + "$ref": "#/definitions/ResourceTypeFilter" + }, + "Teradata": { + "$ref": "#/definitions/ResourceTypeFilter" + }, + "Oracle": { + "$ref": "#/definitions/ResourceTypeFilter" + }, + "SapS4Hana": { + "$ref": "#/definitions/ResourceTypeFilter" + }, + "SapEcc": { + "$ref": "#/definitions/ResourceTypeFilter" + }, + "PowerBI": { + "$ref": "#/definitions/ResourceTypeFilter" + } + } + }, + "credential": { + "allOf": [ + { + "$ref": "#/definitions/CredentialReference" + } + ] + } + } + }, + "AzureSubscriptionCredentialScanProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ExpandingResourceScanProperties" + } + ] + }, + "AzureSubscriptionCredentialScan": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Scan" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureSubscriptionCredentialScanProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AzureSubscriptionCredential" + }, + "AzureSubscriptionMsiScanProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ExpandingResourceScanProperties" + } + ] + }, + "AzureSubscriptionMsiScan": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Scan" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureSubscriptionMsiScanProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AzureSubscriptionMsi" + }, + "AzureResourceGroupCredentialScanProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ExpandingResourceScanProperties" + } + ] + }, + "AzureResourceGroupCredentialScan": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Scan" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureResourceGroupCredentialScanProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AzureResourceGroupCredential" + }, + "AzureResourceGroupMsiScanProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ExpandingResourceScanProperties" + } + ] + }, + "AzureResourceGroupMsiScan": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Scan" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureResourceGroupMsiScanProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AzureResourceGroupMsi" + }, + "AzureSynapseWorkspaceCredentialScanProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ExpandingResourceScanProperties" + } + ] + }, + "AzureSynapseWorkspaceCredentialScan": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Scan" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureSynapseWorkspaceCredentialScanProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AzureSynapseWorkspaceCredential" + }, + "AzureSynapseWorkspaceMsiScanProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ExpandingResourceScanProperties" + } + ] + }, + "AzureSynapseWorkspaceMsiScan": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Scan" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureSynapseWorkspaceMsiScanProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AzureSynapseWorkspaceMsi" + }, + "AzureSynapseCredentialScanProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ExpandingResourceScanProperties" + } + ] + }, + "AzureSynapseCredentialScan": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Scan" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureSynapseCredentialScanProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AzureSynapseCredential" + }, + "AzureSynapseMsiScanProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ExpandingResourceScanProperties" + } + ] + }, + "AzureSynapseMsiScan": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Scan" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureSynapseMsiScanProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AzureSynapseMsi" + }, + "AdlsGen1CredentialScanProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanProperties" + } + ], + "properties": { + "credential": { + "allOf": [ + { + "$ref": "#/definitions/CredentialReference" + } + ] + } + } + }, + "AdlsGen1CredentialScan": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Scan" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AdlsGen1CredentialScanProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AdlsGen1Credential" + }, + "AdlsGen1MsiScanProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanProperties" + } + ] + }, + "AdlsGen1MsiScan": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Scan" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AdlsGen1MsiScanProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AdlsGen1Msi" + }, + "AdlsGen2CredentialScanProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanProperties" + } + ], + "properties": { + "credential": { + "allOf": [ + { + "$ref": "#/definitions/CredentialReference" + } + ] + } + } + }, + "AdlsGen2CredentialScan": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Scan" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AdlsGen2CredentialScanProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AdlsGen2Credential" + }, + "AdlsGen2MsiScanProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanProperties" + } + ] + }, + "AdlsGen2MsiScan": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Scan" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AdlsGen2MsiScanProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AdlsGen2Msi" + }, + "AmazonAccountCredentialScanProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ExpandingResourceScanProperties" + } + ] + }, + "AmazonAccountCredentialScan": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Scan" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AmazonAccountCredentialScanProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AmazonAccountCredential" + }, + "AmazonS3CredentialScanProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanProperties" + } + ], + "properties": { + "credential": { + "allOf": [ + { + "$ref": "#/definitions/CredentialReference" + } + ] + }, + "roleARN": { + "type": "string" + }, + "isMauiScan": { + "type": "boolean" + } + } + }, + "AmazonS3CredentialScan": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Scan" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AmazonS3CredentialScanProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AmazonS3Credential" + }, + "AmazonS3RoleARNScanProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanProperties" + } + ], + "properties": { + "credential": { + "allOf": [ + { + "$ref": "#/definitions/CredentialReference" + } + ] + }, + "roleARN": { + "type": "string" + }, + "isMauiScan": { + "type": "boolean" + } + } + }, + "AmazonS3RoleARNScan": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Scan" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AmazonS3RoleARNScanProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AmazonS3RoleARN" + }, + "AmazonSqlCredentialScanProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanProperties" + } + ], + "properties": { + "credential": { + "allOf": [ + { + "$ref": "#/definitions/CredentialReference" + } + ] + }, + "serverEndpoint": { + "type": "string" + }, + "databaseName": { + "type": "string" + }, + "port": { + "format": "int32", + "type": "integer" + }, + "vpcEndpointServiceName": { + "type": "string" + } + } + }, + "AmazonSqlCredentialScan": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Scan" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AmazonSqlCredentialScanProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AmazonSqlCredential" + }, + "AzureCosmosDbCredentialScanProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanProperties" + } + ], + "properties": { + "credential": { + "allOf": [ + { + "$ref": "#/definitions/CredentialReference" + } + ] + }, + "databaseName": { + "type": "string" + } + } + }, + "AzureCosmosDbCredentialScan": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Scan" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureCosmosDbCredentialScanProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AzureCosmosDbCredential" + }, + "AzureDataExplorerCredentialScanProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanProperties" + } + ], + "properties": { + "credential": { + "allOf": [ + { + "$ref": "#/definitions/CredentialReference" + } + ] + }, + "database": { + "type": "string" + } + } + }, + "AzureDataExplorerCredentialScan": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Scan" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureDataExplorerCredentialScanProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AzureDataExplorerCredential" + }, + "AzureDataExplorerMsiScanProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanProperties" + } + ], + "properties": { + "database": { + "type": "string" + } + } + }, + "AzureDataExplorerMsiScan": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Scan" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureDataExplorerMsiScanProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AzureDataExplorerMsi" + }, + "AzureFileServiceCredentialScanProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanProperties" + } + ], + "properties": { + "credential": { + "allOf": [ + { + "$ref": "#/definitions/CredentialReference" + } + ] + }, + "shareName": { + "type": "string" + } + } + }, + "AzureFileServiceCredentialScan": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Scan" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureFileServiceCredentialScanProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AzureFileServiceCredential" + }, + "AzureSqlScanProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanProperties" + } + ], + "properties": { + "serverEndpoint": { + "type": "string" + }, + "databaseName": { + "type": "string" + } + } + }, + "AzureSqlCredentialScanProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureSqlScanProperties" + } + ], + "properties": { + "credential": { + "allOf": [ + { + "$ref": "#/definitions/CredentialReference" + } + ] + } + } + }, + "AzureSqlDatabaseCredentialScanProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureSqlCredentialScanProperties" + } + ] + }, + "AzureSqlDatabaseCredentialScan": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Scan" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureSqlDatabaseCredentialScanProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AzureSqlDatabaseCredential" + }, + "AzureSqlDatabaseMsiScanProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureSqlScanProperties" + } + ] + }, + "AzureSqlDatabaseMsiScan": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Scan" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureSqlDatabaseMsiScanProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AzureSqlDatabaseMsi" + }, + "AmazonPostgreSqlCredentialScanProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanProperties" + } + ], + "properties": { + "credential": { + "allOf": [ + { + "$ref": "#/definitions/CredentialReference" + } + ] + }, + "serverEndpoint": { + "type": "string" + }, + "databaseName": { + "type": "string" + }, + "port": { + "format": "int32", + "type": "integer" + }, + "vpcEndpointServiceName": { + "type": "string" + } + } + }, + "AmazonPostgreSqlCredentialScan": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Scan" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AmazonPostgreSqlCredentialScanProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AmazonPostgreSqlCredential" + }, + "AmazonPostgreSqlRoleARNScanProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanProperties" + } + ], + "properties": { + "credential": { + "allOf": [ + { + "$ref": "#/definitions/CredentialReference" + } + ] + }, + "serverEndpoint": { + "type": "string" + }, + "databaseName": { + "type": "string" + }, + "port": { + "format": "int32", + "type": "integer" + }, + "vpcEndpointServiceName": { + "type": "string" + } + } + }, + "AmazonPostgreSqlRoleARNScan": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Scan" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AmazonPostgreSqlRoleARNScanProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AmazonPostgreSqlRoleARN" + }, + "AzurePostgreSqlCredentialScanProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanProperties" + } + ], + "properties": { + "credential": { + "allOf": [ + { + "$ref": "#/definitions/CredentialReference" + } + ] + }, + "serverEndpoint": { + "type": "string" + }, + "databaseName": { + "type": "string" + }, + "port": { + "format": "int32", + "type": "integer" + }, + "sslMode": { + "format": "int32", + "type": "integer" + } + } + }, + "AzurePostgreSqlCredentialScan": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Scan" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzurePostgreSqlCredentialScanProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AzurePostgreSqlCredential" + }, + "SqlServerDatabaseCredentialScanProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureSqlCredentialScanProperties" + } + ] + }, + "SqlServerDatabaseCredentialScan": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Scan" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/SqlServerDatabaseCredentialScanProperties" + } + ] + } + }, + "x-ms-discriminator-value": "SqlServerDatabaseCredential" + }, + "AzureSqlDatabaseManagedInstanceCredentialScanProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureSqlCredentialScanProperties" + } + ] + }, + "AzureSqlDatabaseManagedInstanceCredentialScan": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Scan" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureSqlDatabaseManagedInstanceCredentialScanProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AzureSqlDatabaseManagedInstanceCredential" + }, + "AzureSqlDatabaseManagedInstanceMsiScanProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureSqlScanProperties" + } + ] + }, + "AzureSqlDatabaseManagedInstanceMsiScan": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Scan" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureSqlDatabaseManagedInstanceMsiScanProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AzureSqlDatabaseManagedInstanceMsi" + }, + "AzureSqlDataWarehouseCredentialScanProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureSqlCredentialScanProperties" + } + ] + }, + "AzureSqlDataWarehouseCredentialScan": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Scan" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureSqlDataWarehouseCredentialScanProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AzureSqlDataWarehouseCredential" + }, + "AzureSqlDataWarehouseMsiScanProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureSqlScanProperties" + } + ] + }, + "AzureSqlDataWarehouseMsiScan": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Scan" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureSqlDataWarehouseMsiScanProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AzureSqlDataWarehouseMsi" + }, + "AzureMySqlScanProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanProperties" + } + ], + "properties": { + "serverEndpoint": { + "type": "string" + }, + "port": { + "format": "int32", + "type": "integer" + }, + "databaseName": { + "type": "string" + }, + "credential": { + "allOf": [ + { + "$ref": "#/definitions/CredentialReference" + } + ] + } + } + }, + "AzureMySqlCredentialScanProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureMySqlScanProperties" + } + ] + }, + "AzureMySqlCredentialScan": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Scan" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureMySqlCredentialScanProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AzureMySqlCredential" + }, + "MitiScanProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanProperties" + } + ], + "properties": { + "maximumMemoryAllowedInGb": { + "type": "string" + }, + "mitiCache": { + "type": "string" + } + } + }, + "AzureStorageCredentialScanProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanProperties" + } + ], + "properties": { + "credential": { + "allOf": [ + { + "$ref": "#/definitions/CredentialReference" + } + ] + } + } + }, + "AzureStorageCredentialScan": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Scan" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureStorageCredentialScanProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AzureStorageCredential" + }, + "AzureStorageMsiScanProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanProperties" + } + ] + }, + "AzureStorageMsiScan": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Scan" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureStorageMsiScanProperties" + } + ] + } + }, + "x-ms-discriminator-value": "AzureStorageMsi" + }, + "TeradataTeradataCredentialScanProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MitiScanProperties" + } + ], + "properties": { + "credential": { + "allOf": [ + { + "$ref": "#/definitions/CredentialReference" + } + ] + }, + "schema": { + "type": "string" + }, + "driverLocation": { + "type": "string" + } + } + }, + "TeradataTeradataCredentialScan": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Scan" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/TeradataTeradataCredentialScanProperties" + } + ] + } + }, + "x-ms-discriminator-value": "TeradataTeradataCredential" + }, + "TeradataUserPassScanProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanProperties" + } + ], + "properties": { + "username": { + "type": "string" + }, + "password": { + "type": "string" + } + } + }, + "TeradataUserPassScan": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Scan" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/TeradataUserPassScanProperties" + } + ] + } + }, + "x-ms-discriminator-value": "TeradataUserPass" + }, + "TeradataTeradataUserPassScanProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MitiScanProperties" + } + ], + "properties": { + "username": { + "type": "string" + }, + "password": { + "type": "string" + }, + "schema": { + "type": "string" + }, + "driverLocation": { + "type": "string" + } + } + }, + "TeradataTeradataUserPassScan": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Scan" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/TeradataTeradataUserPassScanProperties" + } + ] + } + }, + "x-ms-discriminator-value": "TeradataTeradataUserPass" + }, + "OracleOracleCredentialScanProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MitiScanProperties" + } + ], + "properties": { + "credential": { + "allOf": [ + { + "$ref": "#/definitions/CredentialReference" + } + ] + }, + "schema": { + "type": "string" + }, + "driverLocation": { + "type": "string" + } + } + }, + "OracleOracleCredentialScan": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Scan" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/OracleOracleCredentialScanProperties" + } + ] + } + }, + "x-ms-discriminator-value": "OracleOracleCredential" + }, + "OracleOracleUserPassScanProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MitiScanProperties" + } + ], + "properties": { + "username": { + "type": "string" + }, + "password": { + "type": "string" + }, + "schema": { + "type": "string" + }, + "driverLocation": { + "type": "string" + } + } + }, + "OracleOracleUserPassScan": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Scan" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/OracleOracleUserPassScanProperties" + } + ] + } + }, + "x-ms-discriminator-value": "OracleOracleUserPass" + }, + "SapS4HanaSapS4HanaCredentialScanProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MitiScanProperties" + } + ], + "properties": { + "clientId": { + "type": "string" + }, + "credential": { + "allOf": [ + { + "$ref": "#/definitions/CredentialReference" + } + ] + }, + "jCoLibraryPath": { + "type": "string" + } + } + }, + "SapS4HanaSapS4HanaCredentialScan": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Scan" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/SapS4HanaSapS4HanaCredentialScanProperties" + } + ] + } + }, + "x-ms-discriminator-value": "SapS4HanaSapS4HanaCredential" + }, + "SapS4HanaSapS4HanaUserPassScanProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MitiScanProperties" + } + ], + "properties": { + "clientId": { + "type": "string" + }, + "username": { + "type": "string" + }, + "password": { + "type": "string" + }, + "jCoLibraryPath": { + "type": "string" + } + } + }, + "SapS4HanaSapS4HanaUserPassScan": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Scan" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/SapS4HanaSapS4HanaUserPassScanProperties" + } + ] + } + }, + "x-ms-discriminator-value": "SapS4HanaSapS4HanaUserPass" + }, + "SapEccSapEccCredentialScanProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MitiScanProperties" + } + ], + "properties": { + "clientId": { + "type": "string" + }, + "credential": { + "allOf": [ + { + "$ref": "#/definitions/CredentialReference" + } + ] + }, + "jCoLibraryPath": { + "type": "string" + } + } + }, + "SapEccSapEccCredentialScan": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Scan" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/SapEccSapEccCredentialScanProperties" + } + ] + } + }, + "x-ms-discriminator-value": "SapEccSapEccCredential" + }, + "SapEccSapEccUserPassScanProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MitiScanProperties" + } + ], + "properties": { + "clientId": { + "type": "string" + }, + "username": { + "type": "string" + }, + "password": { + "type": "string" + }, + "jCoLibraryPath": { + "type": "string" + } + } + }, + "SapEccSapEccUserPassScan": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Scan" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/SapEccSapEccUserPassScanProperties" + } + ] + } + }, + "x-ms-discriminator-value": "SapEccSapEccUserPass" + }, + "PowerBIDelegatedScanProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanProperties" + } + ], + "properties": { + "tenant": { + "type": "string" + }, + "authenticationType": { + "type": "string" + }, + "clientId": { + "type": "string" + }, + "userName": { + "type": "string" + }, + "password": { + "type": "string" + }, + "includePersonalWorkspaces": { + "type": "boolean" + } + } + }, + "PowerBIDelegatedScan": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Scan" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/PowerBIDelegatedScanProperties" + } + ] + } + }, + "x-ms-discriminator-value": "PowerBIDelegated" + }, + "PowerBIMsiScanProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScanProperties" + } + ], + "properties": { + "includePersonalWorkspaces": { + "type": "boolean" + } + } + }, + "PowerBIMsiScan": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Scan" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/PowerBIMsiScanProperties" + } + ] + } + }, + "x-ms-discriminator-value": "PowerBIMsi" + }, + "AzureSubscriptionSystemScanRuleset": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SystemScanRuleset" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureSubscriptionScanRulesetProperties" + } + ] + } + }, + "x-ms-discriminator-value": "None" + }, + "AzureResourceGroupSystemScanRuleset": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SystemScanRuleset" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureResourceGroupScanRulesetProperties" + } + ] + } + }, + "x-ms-discriminator-value": "None" + }, + "AzureSynapseWorkspaceSystemScanRuleset": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SystemScanRuleset" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureSynapseWorkspaceScanRulesetProperties" + } + ] + } + }, + "x-ms-discriminator-value": "None" + }, + "AzureSynapseSystemScanRuleset": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SystemScanRuleset" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureSynapseScanRulesetProperties" + } + ] + } + }, + "x-ms-discriminator-value": "None" + }, + "AdlsGen1SystemScanRuleset": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SystemScanRuleset" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AdlsGen1ScanRulesetProperties" + } + ] + } + }, + "x-ms-discriminator-value": "None" + }, + "AdlsGen2SystemScanRuleset": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SystemScanRuleset" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AdlsGen2ScanRulesetProperties" + } + ] + } + }, + "x-ms-discriminator-value": "None" + }, + "AmazonAccountSystemScanRuleset": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SystemScanRuleset" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AmazonAccountScanRulesetProperties" + } + ] + } + }, + "x-ms-discriminator-value": "None" + }, + "AmazonS3SystemScanRuleset": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SystemScanRuleset" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AmazonS3ScanRulesetProperties" + } + ] + } + }, + "x-ms-discriminator-value": "None" + }, + "AmazonSqlSystemScanRuleset": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SystemScanRuleset" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AmazonSqlScanRulesetProperties" + } + ] + } + }, + "x-ms-discriminator-value": "None" + }, + "AzureCosmosDbSystemScanRuleset": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SystemScanRuleset" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureCosmosDbScanRulesetProperties" + } + ] + } + }, + "x-ms-discriminator-value": "None" + }, + "AzureDataExplorerSystemScanRuleset": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SystemScanRuleset" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureDataExplorerScanRulesetProperties" + } + ] + } + }, + "x-ms-discriminator-value": "None" + }, + "AzureFileServiceSystemScanRuleset": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SystemScanRuleset" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureFileServiceScanRulesetProperties" + } + ] + } + }, + "x-ms-discriminator-value": "None" + }, + "AzureSqlDatabaseSystemScanRuleset": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SystemScanRuleset" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureSqlDatabaseScanRulesetProperties" + } + ] + } + }, + "x-ms-discriminator-value": "None" + }, + "AmazonPostgreSqlSystemScanRuleset": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SystemScanRuleset" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AmazonPostgreSqlScanRulesetProperties" + } + ] + } + }, + "x-ms-discriminator-value": "None" + }, + "AzurePostgreSqlSystemScanRuleset": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SystemScanRuleset" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzurePostgreSqlScanRulesetProperties" + } + ] + } + }, + "x-ms-discriminator-value": "None" + }, + "SqlServerDatabaseSystemScanRuleset": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SystemScanRuleset" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/SqlServerDatabaseScanRulesetProperties" + } + ] + } + }, + "x-ms-discriminator-value": "None" + }, + "AzureSqlDatabaseManagedInstanceSystemScanRuleset": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SystemScanRuleset" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureSqlDatabaseManagedInstanceScanRulesetProperties" + } + ] + } + }, + "x-ms-discriminator-value": "None" + }, + "AzureSqlDataWarehouseSystemScanRuleset": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SystemScanRuleset" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureSqlDataWarehouseScanRulesetProperties" + } + ] + } + }, + "x-ms-discriminator-value": "None" + }, + "AzureMySqlSystemScanRuleset": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SystemScanRuleset" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureMySqlScanRulesetProperties" + } + ] + } + }, + "x-ms-discriminator-value": "None" + }, + "AzureStorageSystemScanRuleset": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SystemScanRuleset" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AzureStorageScanRulesetProperties" + } + ] + } + }, + "x-ms-discriminator-value": "None" + }, + "TeradataSystemScanRuleset": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SystemScanRuleset" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/TeradataScanRulesetProperties" + } + ] + } + }, + "x-ms-discriminator-value": "None" + }, + "OracleSystemScanRuleset": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SystemScanRuleset" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/OracleScanRulesetProperties" + } + ] + } + }, + "x-ms-discriminator-value": "None" + }, + "SapS4HanaSystemScanRuleset": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SystemScanRuleset" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/SapS4HanaScanRulesetProperties" + } + ] + } + }, + "x-ms-discriminator-value": "None" + }, + "SapEccSystemScanRuleset": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SystemScanRuleset" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/SapEccScanRulesetProperties" + } + ] + } + }, + "x-ms-discriminator-value": "None" + }, + "PowerBISystemScanRuleset": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SystemScanRuleset" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/PowerBIScanRulesetProperties" + } + ] + } + }, + "x-ms-discriminator-value": "None" + } + }, + "parameters": { + "api-version": { + "in": "query", + "name": "api-version", + "description": "The api version to use.", + "required": true, + "type": "string", + "x-ms-client-name": "ApiVersion" + }, + "Endpoint": { + "in": "path", + "name": "Endpoint", + "description": "The scanning endpoint of your purview account. Example: https://{accountName}.purview.azure.com", + "required": true, + "type": "string", + "x-ms-parameter-location": "client", + "x-ms-skip-url-encoding": true + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow." + } + } +} diff --git a/specification/purview/data-plane/readme.md b/specification/purview/data-plane/readme.md index d27a4af300dc..028cb9b77d12 100644 --- a/specification/purview/data-plane/readme.md +++ b/specification/purview/data-plane/readme.md @@ -38,7 +38,7 @@ input-file: ``` -These are the global settings for the Purview API. +These are the global settings for the Purview Scanning API. ``` yaml openapi-type: data-plane @@ -58,6 +58,15 @@ modelerfour: lenient-model-deduplication: true ``` +These settings apply only when `--tag=package-2021-10-01-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2021-10-01-preview' +input-file: +- Azure.Analytics.Purview.Scanning/preview/2021-10-01-preview/scanningService.json +modelerfour: + lenient-model-deduplication: true +``` + These are the global settings for the Purview API. ``` yaml From 34a2c0723155d134311419fd997925ce96b85bec Mon Sep 17 00:00:00 2001 From: Heath Stewart Date: Thu, 28 Oct 2021 12:19:14 -0700 Subject: [PATCH 12/19] Resolve archboard feedback for Question Answering (#16589) --- .../data-plane/Language/stable/2021-10-01/questionanswering.json | 1 + 1 file changed, 1 insertion(+) diff --git a/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/questionanswering.json b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/questionanswering.json index c528c3340170..aba54da148a5 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/questionanswering.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/questionanswering.json @@ -145,6 +145,7 @@ "minimum": 0 }, "context": { + "x-ms-client-name": "answerContext", "description": "Context object with previous QnA's information.", "$ref": "#/definitions/KnowledgeBaseAnswerContext" }, From 50d599c9caa01a87f638d6a522ef0c45df16faf5 Mon Sep 17 00:00:00 2001 From: Daniel Stack Date: Thu, 28 Oct 2021 18:04:43 -0700 Subject: [PATCH 13/19] Dev maps microsoft.maps 2021 12 01 preview (#16153) * Adds base for updating Microsoft.Maps from version preview/2021-07-01-preview to version 2021-12-01-preview * Updates readme * Updates API version in new specs and examples * CORS and AccountSas * fix examples * fixing * fix example * fixing example * fix convention and systemdata * creator examples * fix by rule supress * content updates * fixes from specs pipeline --- .../examples/AccountListSAS.json | 25 + .../examples/CreateAccount.json | 111 ++ .../examples/CreateAccountGen2.json | 111 ++ .../CreateAccountManagedIdentity.json | 139 ++ .../examples/CreateMapsCreator.json | 52 + .../examples/DeleteAccount.json | 12 + .../examples/DeleteMapsCreator.json | 13 + .../examples/GetAccount.json | 40 + .../examples/GetMapsCreator.json | 27 + .../examples/GetOperations.json | 104 ++ .../examples/GetOperationsSubscription.json | 105 ++ .../examples/ListAccountsByResourceGroup.json | 54 + .../examples/ListAccountsBySubscription.json | 53 + .../2021-12-01-preview/examples/ListKeys.json | 18 + .../examples/ListMapsCreatorsByAccount.json | 31 + .../examples/RegenerateKey.json | 21 + .../examples/UpdateAccount.json | 44 + .../examples/UpdateAccountGen1.json | 43 + .../examples/UpdateAccountGen2.json | 43 + .../UpdateAccountManagedIdentity.json | 73 + .../examples/UpdateMapsCreator.json | 35 + .../2021-12-01-preview/maps-management.json | 1438 +++++++++++++++++ specification/maps/resource-manager/readme.md | 14 +- 23 files changed, 2604 insertions(+), 2 deletions(-) create mode 100644 specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/AccountListSAS.json create mode 100644 specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/CreateAccount.json create mode 100644 specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/CreateAccountGen2.json create mode 100644 specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/CreateAccountManagedIdentity.json create mode 100644 specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/CreateMapsCreator.json create mode 100644 specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/DeleteAccount.json create mode 100644 specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/DeleteMapsCreator.json create mode 100644 specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/GetAccount.json create mode 100644 specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/GetMapsCreator.json create mode 100644 specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/GetOperations.json create mode 100644 specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/GetOperationsSubscription.json create mode 100644 specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/ListAccountsByResourceGroup.json create mode 100644 specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/ListAccountsBySubscription.json create mode 100644 specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/ListKeys.json create mode 100644 specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/ListMapsCreatorsByAccount.json create mode 100644 specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/RegenerateKey.json create mode 100644 specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/UpdateAccount.json create mode 100644 specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/UpdateAccountGen1.json create mode 100644 specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/UpdateAccountGen2.json create mode 100644 specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/UpdateAccountManagedIdentity.json create mode 100644 specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/UpdateMapsCreator.json create mode 100644 specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/maps-management.json diff --git a/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/AccountListSAS.json b/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/AccountListSAS.json new file mode 100644 index 000000000000..4362316f66af --- /dev/null +++ b/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/AccountListSAS.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2021-12-01-preview", + "subscriptionId": "21a9967a-e8a9-4656-a70b-96ff1c4d05a0", + "resourceGroupName": "myResourceGroup", + "accountName": "myMapsAccount", + "MapsAccountSasParameters": { + "signingKey": "primaryKey", + "principalId": "e917f87b-324d-4728-98ed-e31d311a7d65", + "regions": [ + "eastus" + ], + "maxRatePerSecond": 500, + "start": "2017-05-24T10:42:03.1567373Z", + "expiry": "2017-05-24T11:42:03.1567373Z" + } + }, + "responses": { + "200": { + "body": { + "accountSasToken": "accountSasToken" + } + } + } +} diff --git a/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/CreateAccount.json b/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/CreateAccount.json new file mode 100644 index 000000000000..0e7f62a205f5 --- /dev/null +++ b/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/CreateAccount.json @@ -0,0 +1,111 @@ +{ + "parameters": { + "api-version": "2021-12-01-preview", + "subscriptionId": "21a9967a-e8a9-4656-a70b-96ff1c4d05a0", + "resourceGroupName": "myResourceGroup", + "accountName": "myMapsAccount", + "MapsAccount": { + "location": "eastus", + "sku": { + "name": "S0" + }, + "kind": "Gen1", + "tags": { + "test": "true" + }, + "properties": { + "disableLocalAuth": false, + "cors": { + "corsRules": [ + { + "allowedOrigins": [ + "http://www.contoso.com", + "http://www.fabrikam.com" + ] + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount", + "name": "myMapsAccount", + "type": "Microsoft.Maps/accounts", + "kind": "Gen1", + "location": "eastus", + "tags": { + "test": "true" + }, + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2021-07-02T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-07-02T01:01:01.1075056Z" + }, + "sku": { + "name": "S0", + "tier": "Standard" + }, + "properties": { + "uniqueId": "b2e763e6-d6f3-4858-9e2b-7cf8df85c593", + "provisioningState": "Succeeded", + "disableLocalAuth": false, + "cors": { + "corsRules": [ + { + "allowedOrigins": [ + "http://www.contoso.com", + "http://www.fabrikam.com" + ] + } + ] + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount", + "name": "myMapsAccount", + "type": "Microsoft.Maps/accounts", + "kind": "Gen1", + "location": "eastus", + "tags": { + "test": "true" + }, + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2021-07-02T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-07-02T01:01:01.1075056Z" + }, + "sku": { + "name": "S0", + "tier": "Standard" + }, + "properties": { + "uniqueId": "b2e763e6-d6f3-4858-9e2b-7cf8df85c593", + "provisioningState": "Succeeded", + "disableLocalAuth": false, + "cors": { + "corsRules": [ + { + "allowedOrigins": [ + "http://www.contoso.com", + "http://www.fabrikam.com" + ] + } + ] + } + } + } + } + } +} diff --git a/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/CreateAccountGen2.json b/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/CreateAccountGen2.json new file mode 100644 index 000000000000..9de8816b76e0 --- /dev/null +++ b/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/CreateAccountGen2.json @@ -0,0 +1,111 @@ +{ + "parameters": { + "api-version": "2021-12-01-preview", + "subscriptionId": "21a9967a-e8a9-4656-a70b-96ff1c4d05a0", + "resourceGroupName": "myResourceGroup", + "accountName": "myMapsAccount", + "MapsAccount": { + "location": "eastus", + "sku": { + "name": "G2" + }, + "kind": "Gen2", + "tags": { + "test": "true" + }, + "properties": { + "disableLocalAuth": true, + "cors": { + "corsRules": [ + { + "allowedOrigins": [ + "http://www.contoso.com", + "http://www.fabrikam.com" + ] + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount", + "name": "myMapsAccount", + "type": "Microsoft.Maps/accounts", + "kind": "Gen2", + "location": "eastus", + "tags": { + "test": "true" + }, + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2021-07-02T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-07-02T01:01:01.1075056Z" + }, + "sku": { + "name": "G2", + "tier": "Standard" + }, + "properties": { + "uniqueId": "b2e763e6-d6f3-4858-9e2b-7cf8df85c593", + "provisioningState": "Succeeded", + "disableLocalAuth": true, + "cors": { + "corsRules": [ + { + "allowedOrigins": [ + "http://www.contoso.com", + "http://www.fabrikam.com" + ] + } + ] + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount", + "name": "myMapsAccount", + "type": "Microsoft.Maps/accounts", + "kind": "Gen2", + "location": "eastus", + "tags": { + "test": "true" + }, + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2021-07-02T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-07-02T01:01:01.1075056Z" + }, + "sku": { + "name": "G2", + "tier": "Standard" + }, + "properties": { + "uniqueId": "b2e763e6-d6f3-4858-9e2b-7cf8df85c593", + "provisioningState": "Succeeded", + "disableLocalAuth": true, + "cors": { + "corsRules": [ + { + "allowedOrigins": [ + "http://www.contoso.com", + "http://www.fabrikam.com" + ] + } + ] + } + } + } + } + } +} diff --git a/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/CreateAccountManagedIdentity.json b/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/CreateAccountManagedIdentity.json new file mode 100644 index 000000000000..f817c604f0f2 --- /dev/null +++ b/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/CreateAccountManagedIdentity.json @@ -0,0 +1,139 @@ +{ + "parameters": { + "api-version": "2021-12-01-preview", + "subscriptionId": "21a9967a-e8a9-4656-a70b-96ff1c4d05a0", + "resourceGroupName": "myResourceGroup", + "accountName": "myMapsAccount", + "MapsAccount": { + "location": "eastus", + "sku": { + "name": "G2" + }, + "kind": "Gen2", + "tags": { + "test": "true" + }, + "identity": { + "type": "SystemAssigned, UserAssigned", + "userAssignedIdentities": { + "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName": {} + } + }, + "properties": { + "disableLocalAuth": false, + "linkedResources": [ + { + "id": "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Storage/accounts/mystorageacc", + "uniqueName": "myBatchStorageAccount" + }, + { + "id": "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Storage/accounts/mystorageacc", + "uniqueName": "myBlobDataSource" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount", + "name": "myMapsAccount", + "type": "Microsoft.Maps/accounts", + "kind": "Gen2", + "location": "eastus", + "tags": { + "test": "true" + }, + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2021-07-02T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-07-02T01:01:01.1075056Z" + }, + "sku": { + "name": "G2", + "tier": "Standard" + }, + "identity": { + "type": "SystemAssigned, UserAssigned", + "principalId": "77f72dac-e0aa-484e-9acd-e5e7075310ef", + "tenantId": "06006684-60c1-4954-a20c-ffd8fbea7276", + "userAssignedIdentities": { + "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName": { + "clientId": "b602d315-01b5-4265-af23-859edc4f2431", + "principalId": "ac287332-364a-41d9-a567-9ad86b9fc299" + } + } + }, + "properties": { + "uniqueId": "b2e763e6-d6f3-4858-9e2b-7cf8df85c593", + "provisioningState": "Succeeded", + "disableLocalAuth": true, + "linkedResources": [ + { + "id": "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Storage/accounts/mystorageacc", + "uniqueName": "myBatchStorageAccount" + }, + { + "id": "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Storage/accounts/mystorageacc", + "uniqueName": "myBlobDataSource" + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount", + "name": "myMapsAccount", + "type": "Microsoft.Maps/accounts", + "kind": "Gen2", + "location": "eastus", + "tags": { + "test": "true" + }, + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2021-07-02T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-07-02T01:01:01.1075056Z" + }, + "sku": { + "name": "G2", + "tier": "Standard" + }, + "identity": { + "type": "SystemAssigned, UserAssigned", + "principalId": "77f72dac-e0aa-484e-9acd-e5e7075310ef", + "tenantId": "06006684-60c1-4954-a20c-ffd8fbea7276", + "userAssignedIdentities": { + "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName": { + "clientId": "b602d315-01b5-4265-af23-859edc4f2431", + "principalId": "ac287332-364a-41d9-a567-9ad86b9fc299" + } + } + }, + "properties": { + "uniqueId": "b2e763e6-d6f3-4858-9e2b-7cf8df85c593", + "provisioningState": "Succeeded", + "disableLocalAuth": true, + "linkedResources": [ + { + "id": "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Storage/accounts/mystorageacc", + "uniqueName": "myBatchStorageAccount" + }, + { + "id": "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Storage/accounts/mystorageacc", + "uniqueName": "myBlobDataSource" + } + ] + } + } + } + } +} diff --git a/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/CreateMapsCreator.json b/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/CreateMapsCreator.json new file mode 100644 index 000000000000..123f1b65c686 --- /dev/null +++ b/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/CreateMapsCreator.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2021-12-01-preview", + "subscriptionId": "21a9967a-e8a9-4656-a70b-96ff1c4d05a0", + "resourceGroupName": "myResourceGroup", + "accountName": "myMapsAccount", + "creatorName": "myCreator", + "CreatorResource": { + "location": "eastus2", + "tags": { + "test": "true" + }, + "properties": { + "storageUnits": 5 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount/creators/myCreator", + "name": "myCreator", + "type": "Microsoft.Maps/accounts/creators", + "location": "eastus2", + "tags": { + "test": "true" + }, + "systemData": null, + "properties": { + "provisioningState": "Created", + "storageUnits": 5 + } + } + }, + "201": { + "body": { + "id": "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount/creators/myCreator", + "name": "myCreator", + "type": "Microsoft.Maps/accounts/creators", + "location": "eastus2", + "tags": { + "test": "true" + }, + "systemData": null, + "properties": { + "provisioningState": "Created", + "storageUnits": 5 + } + } + } + } +} diff --git a/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/DeleteAccount.json b/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/DeleteAccount.json new file mode 100644 index 000000000000..fae9b0b0e13a --- /dev/null +++ b/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/DeleteAccount.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2021-12-01-preview", + "subscriptionId": "21a9967a-e8a9-4656-a70b-96ff1c4d05a0", + "resourceGroupName": "myResourceGroup", + "accountName": "myMapsAccount" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/DeleteMapsCreator.json b/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/DeleteMapsCreator.json new file mode 100644 index 000000000000..abd8f63ac1e7 --- /dev/null +++ b/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/DeleteMapsCreator.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2021-12-01-preview", + "subscriptionId": "21a9967a-e8a9-4656-a70b-96ff1c4d05a0", + "resourceGroupName": "myResourceGroup", + "accountName": "myMapsAccount", + "creatorName": "myCreator" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/GetAccount.json b/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/GetAccount.json new file mode 100644 index 000000000000..209f4b5f976e --- /dev/null +++ b/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/GetAccount.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2021-12-01-preview", + "subscriptionId": "21a9967a-e8a9-4656-a70b-96ff1c4d05a0", + "resourceGroupName": "myResourceGroup", + "accountName": "myMapsAccount" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount", + "name": "myMapsAccount", + "type": "Microsoft.Maps/accounts", + "location": "global", + "kind": "Gen1", + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2021-07-02T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-07-02T01:01:01.1075056Z" + }, + "tags": { + "test": "true" + }, + "sku": { + "name": "S0", + "tier": "Standard" + }, + "properties": { + "uniqueId": "string", + "disableLocalAuth": false, + "provisioningState": "Succeeded", + "linkedResources": [] + } + } + } + } +} diff --git a/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/GetMapsCreator.json b/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/GetMapsCreator.json new file mode 100644 index 000000000000..2f506329d3a9 --- /dev/null +++ b/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/GetMapsCreator.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2021-12-01-preview", + "subscriptionId": "21a9967a-e8a9-4656-a70b-96ff1c4d05a0", + "resourceGroupName": "myResourceGroup", + "accountName": "myMapsAccount", + "creatorName": "myCreator" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount/creators/myCreator", + "name": "myCreator", + "type": "Microsoft.Maps/accounts/creators", + "location": "unitedstates", + "tags": { + "test": "true" + }, + "systemData": null, + "properties": { + "provisioningState": "Succeeded", + "storageUnits": 5 + } + } + } + } +} diff --git a/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/GetOperations.json b/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/GetOperations.json new file mode 100644 index 000000000000..88173a13a82e --- /dev/null +++ b/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/GetOperations.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "api-version": "2021-12-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Maps/register/action", + "isDataAction": false, + "display": { + "provider": "Microsoft Maps", + "resource": "Maps Account", + "operation": "Register the provider", + "description": "Register the provider" + } + }, + { + "name": "Microsoft.Maps/accounts/write", + "isDataAction": false, + "display": { + "provider": "Microsoft Maps", + "resource": "Maps Account", + "operation": "Create or update a Maps Account.", + "description": "Create or update a Maps Account." + } + }, + { + "name": "Microsoft.Maps/accounts/read", + "isDataAction": false, + "display": { + "provider": "Microsoft Maps", + "resource": "Maps Account", + "operation": "Get a Maps Account.", + "description": "Get a Maps Account." + } + }, + { + "name": "Microsoft.Maps/accounts/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft Maps", + "resource": "Maps Account", + "operation": "Delete a Maps Account.", + "description": "Delete a Maps Account." + } + }, + { + "name": "Microsoft.Maps/accounts/listKeys/action", + "isDataAction": false, + "display": { + "provider": "Microsoft Maps", + "resource": "Maps Account", + "operation": "List keys", + "description": "List Maps Account keys" + } + }, + { + "name": "Microsoft.Maps/accounts/regenerateKey/action", + "isDataAction": false, + "display": { + "provider": "Microsoft Maps", + "resource": "Maps Account", + "operation": "Generate new primary or secondary key", + "description": "Generate new Maps Account primary or secondary key" + } + }, + { + "name": "Microsoft.Maps/accounts/creators/write", + "isDataAction": false, + "display": { + "provider": "Microsoft Maps", + "resource": "Creator", + "operation": "Create or update a Maps Creator.", + "description": "Create or update a Maps Creator." + } + }, + { + "name": "Microsoft.Maps/accounts/creators/read", + "isDataAction": false, + "display": { + "provider": "Microsoft Maps", + "resource": "Creator", + "operation": "Get a Maps Creator.", + "description": "Get a Maps Creator." + } + }, + { + "name": "Microsoft.Maps/accounts/creators/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft Maps", + "resource": "Creator", + "operation": "Delete a Maps Creator.", + "description": "Delete a Maps Creator." + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/GetOperationsSubscription.json b/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/GetOperationsSubscription.json new file mode 100644 index 000000000000..a61f9c98529e --- /dev/null +++ b/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/GetOperationsSubscription.json @@ -0,0 +1,105 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "21a9967a-e8a9-4656-a70b-96ff1c4d05a0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Maps/register/action", + "isDataAction": false, + "display": { + "provider": "Microsoft Maps", + "resource": "Maps Account", + "operation": "Register the provider", + "description": "Register the provider" + } + }, + { + "name": "Microsoft.Maps/accounts/write", + "isDataAction": false, + "display": { + "provider": "Microsoft Maps", + "resource": "Maps Account", + "operation": "Create or update a Maps Account.", + "description": "Create or update a Maps Account." + } + }, + { + "name": "Microsoft.Maps/accounts/read", + "isDataAction": false, + "display": { + "provider": "Microsoft Maps", + "resource": "Maps Account", + "operation": "Get a Maps Account.", + "description": "Get a Maps Account." + } + }, + { + "name": "Microsoft.Maps/accounts/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft Maps", + "resource": "Maps Account", + "operation": "Delete a Maps Account.", + "description": "Delete a Maps Account." + } + }, + { + "name": "Microsoft.Maps/accounts/listKeys/action", + "isDataAction": false, + "display": { + "provider": "Microsoft Maps", + "resource": "Maps Account", + "operation": "List keys", + "description": "List Maps Account keys" + } + }, + { + "name": "Microsoft.Maps/accounts/regenerateKey/action", + "isDataAction": false, + "display": { + "provider": "Microsoft Maps", + "resource": "Maps Account", + "operation": "Generate new primary or secondary key", + "description": "Generate new Maps Account primary or secondary key" + } + }, + { + "name": "Microsoft.Maps/accounts/creators/write", + "isDataAction": false, + "display": { + "provider": "Microsoft Maps", + "resource": "Creator", + "operation": "Create or update a Maps Creator.", + "description": "Create or update a Maps Creator." + } + }, + { + "name": "Microsoft.Maps/accounts/creators/read", + "isDataAction": false, + "display": { + "provider": "Microsoft Maps", + "resource": "Creator", + "operation": "Get a Maps Creator.", + "description": "Get a Maps Creator." + } + }, + { + "name": "Microsoft.Maps/accounts/creators/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft Maps", + "resource": "Creator", + "operation": "Delete a Maps Creator.", + "description": "Delete a Maps Creator." + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/ListAccountsByResourceGroup.json b/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/ListAccountsByResourceGroup.json new file mode 100644 index 000000000000..c85b2d489f2b --- /dev/null +++ b/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/ListAccountsByResourceGroup.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2020-02-01-preview", + "subscriptionId": "21a9967a-e8a9-4656-a70b-96ff1c4d05a0", + "resourceGroupName": "myResourceGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount2", + "name": "myMapsAccount2", + "type": "Microsoft.Maps/accounts", + "location": "global", + "kind": "Gen1", + "tags": { + "test": "true" + }, + "sku": { + "name": "S0", + "tier": "Standard" + }, + "properties": { + "uniqueId": "b2e763e6-d6f3-4858-9e2b-7cf8df85c593", + "provisioningState": "Succeeded", + "disableLocalAuth": false + } + }, + { + "id": "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount", + "name": "myMapsAccount", + "type": "Microsoft.Maps/accounts", + "location": "global", + "kind": "Gen2", + "tags": { + "test": "true" + }, + "sku": { + "name": "G2", + "tier": "Standard" + }, + "properties": { + "uniqueId": "b2e763e6-d6f3-4858-9e2b-7cf8df85c592", + "provisioningState": "Succeeded", + "disableLocalAuth": true + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/ListAccountsBySubscription.json b/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/ListAccountsBySubscription.json new file mode 100644 index 000000000000..87e84c921c88 --- /dev/null +++ b/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/ListAccountsBySubscription.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2021-12-01-preview", + "subscriptionId": "21a9967a-e8a9-4656-a70b-96ff1c4d05a0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount2", + "name": "myMapsAccount2", + "type": "Microsoft.Maps/accounts", + "location": "global", + "kind": "Gen1", + "tags": { + "test": "true" + }, + "sku": { + "name": "S0", + "tier": "Standard" + }, + "properties": { + "uniqueId": "b2e763e6-d6f3-4858-9e2b-7cf8df85c593", + "provisioningState": "Succeeded", + "disableLocalAuth": false + } + }, + { + "id": "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount", + "name": "myMapsAccount", + "type": "Microsoft.Maps/accounts", + "location": "global", + "kind": "Gen2", + "tags": { + "test": "true" + }, + "sku": { + "name": "G2", + "tier": "Standard" + }, + "properties": { + "uniqueId": "b2e763e6-d6f3-4858-9e2b-7cf8df85c592", + "provisioningState": "Succeeded", + "disableLocalAuth": true + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/ListKeys.json b/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/ListKeys.json new file mode 100644 index 000000000000..4b2d2aed9845 --- /dev/null +++ b/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/ListKeys.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2021-12-01-preview", + "subscriptionId": "21a9967a-e8a9-4656-a70b-96ff1c4d05a0", + "resourceGroupName": "myResourceGroup", + "accountName": "myMapsAccount" + }, + "responses": { + "200": { + "body": { + "primaryKey": "", + "primaryKeyLastUpdated": "2021-07-02T01:01:01.1075056Z", + "secondaryKey": "", + "secondaryKeyLastUpdated": "2021-07-02T01:01:01.1075056Z" + } + } + } +} diff --git a/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/ListMapsCreatorsByAccount.json b/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/ListMapsCreatorsByAccount.json new file mode 100644 index 000000000000..dcbc929a3102 --- /dev/null +++ b/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/ListMapsCreatorsByAccount.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2021-12-01-preview", + "subscriptionId": "21a9967a-e8a9-4656-a70b-96ff1c4d05a0", + "resourceGroupName": "myResourceGroup", + "accountName": "myMapsAccount" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount/creators/myCreator", + "name": "myCreator", + "type": "Microsoft.Maps/accounts/creators", + "location": "unitedstates", + "tags": { + "test": "true" + }, + "systemData": null, + "properties": { + "provisioningState": "Succeeded", + "storageUnits": 5 + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/RegenerateKey.json b/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/RegenerateKey.json new file mode 100644 index 000000000000..6a4f8a96989d --- /dev/null +++ b/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/RegenerateKey.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2021-12-01-preview", + "subscriptionId": "21a9967a-e8a9-4656-a70b-96ff1c4d05a0", + "resourceGroupName": "myResourceGroup", + "accountName": "myMapsAccount", + "keySpecification": { + "keyType": "primary" + } + }, + "responses": { + "200": { + "body": { + "primaryKey": "", + "primaryKeyLastUpdated": "2021-07-02T01:01:01.1075056Z", + "secondaryKey": "", + "secondaryKeyLastUpdated": "2021-07-02T01:01:01.1075056Z" + } + } + } +} diff --git a/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/UpdateAccount.json b/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/UpdateAccount.json new file mode 100644 index 000000000000..119c47245e34 --- /dev/null +++ b/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/UpdateAccount.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2021-12-01-preview", + "subscriptionId": "21a9967a-e8a9-4656-a70b-96ff1c4d05a0", + "resourceGroupName": "myResourceGroup", + "accountName": "myMapsAccount", + "MapsAccountUpdateParameters": { + "tags": { + "specialTag": "true" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount", + "name": "myMapsAccount", + "type": "Microsoft.Maps/accounts", + "location": "global", + "kind": "Gen1", + "tags": { + "specialTag": "true" + }, + "sku": { + "name": "S0", + "tier": "Standard" + }, + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2021-07-02T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-07-02T01:01:01.1075056Z" + }, + "properties": { + "uniqueId": "b2e763e6-d6f3-4858-9e2b-7cf8df85c593", + "provisioningState": "Succeeded", + "disableLocalAuth": false + } + } + } + } +} diff --git a/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/UpdateAccountGen1.json b/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/UpdateAccountGen1.json new file mode 100644 index 000000000000..871fe35b996a --- /dev/null +++ b/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/UpdateAccountGen1.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2021-12-01-preview", + "subscriptionId": "21a9967a-e8a9-4656-a70b-96ff1c4d05a0", + "resourceGroupName": "myResourceGroup", + "accountName": "myMapsAccount", + "MapsAccountUpdateParameters": { + "kind": "Gen1", + "sku": { + "name": "S1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount", + "name": "myMapsAccount", + "type": "Microsoft.Maps/accounts", + "location": "global", + "kind": "Gen1", + "sku": { + "name": "S1", + "tier": "Standard" + }, + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2021-07-02T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-07-02T01:01:01.1075056Z" + }, + "properties": { + "uniqueId": "b2e763e6-d6f3-4858-9e2b-7cf8df85c593", + "provisioningState": "Succeeded", + "disableLocalAuth": false, + "linkedResources": [] + } + } + } + } +} diff --git a/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/UpdateAccountGen2.json b/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/UpdateAccountGen2.json new file mode 100644 index 000000000000..266813268435 --- /dev/null +++ b/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/UpdateAccountGen2.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2021-12-01-preview", + "subscriptionId": "21a9967a-e8a9-4656-a70b-96ff1c4d05a0", + "resourceGroupName": "myResourceGroup", + "accountName": "myMapsAccount", + "MapsAccountUpdateParameters": { + "kind": "Gen2", + "sku": { + "name": "G2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount", + "name": "myMapsAccount", + "type": "Microsoft.Maps/accounts", + "location": "global", + "kind": "Gen2", + "sku": { + "name": "G2", + "tier": "Standard" + }, + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2021-07-02T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-07-02T01:01:01.1075056Z" + }, + "properties": { + "uniqueId": "b2e763e6-d6f3-4858-9e2b-7cf8df85c593", + "provisioningState": "Succeeded", + "disableLocalAuth": false, + "linkedResources": [] + } + } + } + } +} diff --git a/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/UpdateAccountManagedIdentity.json b/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/UpdateAccountManagedIdentity.json new file mode 100644 index 000000000000..be6169390967 --- /dev/null +++ b/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/UpdateAccountManagedIdentity.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2021-12-01-preview", + "subscriptionId": "21a9967a-e8a9-4656-a70b-96ff1c4d05a0", + "resourceGroupName": "myResourceGroup", + "accountName": "myMapsAccount", + "MapsAccountUpdateParameters": { + "kind": "Gen2", + "sku": { + "name": "G2" + }, + "identity": { + "type": "SystemAssigned, UserAssigned", + "userAssignedIdentities": { + "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName": {} + } + }, + "properties": { + "linkedResources": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/accounts/{storageName}", + "uniqueName": "myBatchStorageAccount" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount", + "name": "myMapsAccount", + "type": "Microsoft.Maps/accounts", + "location": "eastus", + "kind": "Gen2", + "sku": { + "name": "G2", + "tier": "Standard" + }, + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2021-07-02T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-07-02T01:01:01.1075056Z" + }, + "identity": { + "type": "SystemAssigned, UserAssigned", + "principalId": "77f72dac-e0aa-484e-9acd-e5e7075310ef", + "tenantId": "06006684-60c1-4954-a20c-ffd8fbea7276", + "userAssignedIdentities": { + "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName": { + "clientId": "b602d315-01b5-4265-af23-859edc4f2431", + "principalId": "ac287332-364a-41d9-a567-9ad86b9fc299" + } + } + }, + "properties": { + "uniqueId": "b2e763e6-d6f3-4858-9e2b-7cf8df85c593", + "provisioningState": "Succeeded", + "disableLocalAuth": false, + "linkedResources": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/accounts/{storageName}", + "uniqueName": "myBatchStorageAccount" + } + ] + } + } + } + } +} diff --git a/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/UpdateMapsCreator.json b/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/UpdateMapsCreator.json new file mode 100644 index 000000000000..c25a0d18cb4b --- /dev/null +++ b/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/examples/UpdateMapsCreator.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2021-12-01-preview", + "subscriptionId": "21a9967a-e8a9-4656-a70b-96ff1c4d05a0", + "resourceGroupName": "myResourceGroup", + "accountName": "myMapsAccount", + "creatorName": "myCreator", + "CreatorUpdateParameters": { + "tags": { + "specialTag": "true" + }, + "properties": { + "storageUnits": 10 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount/creators/myCreator", + "name": "myCreator", + "type": "Microsoft.Maps/accounts/creators", + "location": "unitedstates", + "tags": { + "specialTag": "true" + }, + "systemData": null, + "properties": { + "provisioningState": "Succeeded", + "storageUnits": 10 + } + } + } + } +} diff --git a/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/maps-management.json b/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/maps-management.json new file mode 100644 index 000000000000..b7e9f4e9862f --- /dev/null +++ b/specification/maps/resource-manager/Microsoft.Maps/preview/2021-12-01-preview/maps-management.json @@ -0,0 +1,1438 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Maps Resource Provider", + "description": "Resource Provider", + "version": "2021-12-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maps/accounts/{accountName}": { + "put": { + "tags": [ + "Accounts" + ], + "description": "Create or update a Maps Account. A Maps Account holds the keys which allow access to the Maps REST APIs.", + "operationId": "Accounts_CreateOrUpdate", + "x-ms-examples": { + "Create Gen1 Account": { + "$ref": "./examples/CreateAccount.json" + }, + "Create Gen2 Account": { + "$ref": "./examples/CreateAccountGen2.json" + }, + "Create Account with Managed Identities": { + "$ref": "./examples/CreateAccountManagedIdentity.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "name": "MapsAccount", + "in": "body", + "description": "The new or updated parameters for the Maps Account.", + "required": true, + "schema": { + "$ref": "#/definitions/MapsAccount" + } + } + ], + "responses": { + "200": { + "description": "The Account was successfully updated.", + "schema": { + "$ref": "#/definitions/MapsAccount" + } + }, + "201": { + "description": "The Account was successfully created.", + "schema": { + "$ref": "#/definitions/MapsAccount" + } + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Accounts" + ], + "description": "Updates a Maps Account. Only a subset of the parameters may be updated after creation, such as Sku, Tags, Properties.", + "operationId": "Accounts_Update", + "x-ms-examples": { + "Update Account Tags": { + "$ref": "./examples/UpdateAccount.json" + }, + "Update to Gen2 Account": { + "$ref": "./examples/UpdateAccountGen2.json" + }, + "Update to Gen1 Account": { + "$ref": "./examples/UpdateAccountGen1.json" + }, + "Update Account Managed Identities": { + "$ref": "./examples/UpdateAccountManagedIdentity.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "name": "MapsAccountUpdateParameters", + "in": "body", + "description": "The updated parameters for the Maps Account.", + "required": true, + "schema": { + "$ref": "#/definitions/MapsAccountUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The Account was successfully updated.", + "schema": { + "$ref": "#/definitions/MapsAccount" + } + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Accounts" + ], + "description": "Delete a Maps Account.", + "operationId": "Accounts_Delete", + "x-ms-examples": { + "DeleteAccount": { + "$ref": "./examples/DeleteAccount.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + } + ], + "responses": { + "200": { + "description": "The Account was deleted successfully." + }, + "204": { + "description": "The specified Account was not found. Nothing was deleted." + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Accounts" + ], + "description": "Get a Maps Account.", + "operationId": "Accounts_Get", + "x-ms-examples": { + "GetAccount": { + "$ref": "./examples/GetAccount.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful.", + "schema": { + "$ref": "#/definitions/MapsAccount" + } + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maps/accounts": { + "get": { + "tags": [ + "Accounts" + ], + "description": "Get all Maps Accounts in a Resource Group", + "operationId": "Accounts_ListByResourceGroup", + "x-ms-examples": { + "List Accounts By Resource Group": { + "$ref": "./examples/ListAccountsByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful.", + "schema": { + "$ref": "#/definitions/MapsAccounts" + } + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Maps/accounts": { + "get": { + "tags": [ + "Accounts" + ], + "description": "Get all Maps Accounts in a Subscription", + "operationId": "Accounts_ListBySubscription", + "x-ms-examples": { + "List Accounts By Subscription": { + "$ref": "./examples/ListAccountsBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful.", + "schema": { + "$ref": "#/definitions/MapsAccounts" + } + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maps/accounts/{accountName}/listSas": { + "post": { + "tags": [ + "Accounts" + ], + "description": "Create and list an account shared access signature token. Use this SAS token for authentication to Azure Maps REST APIs through various Azure Maps SDKs. As prerequisite to create a SAS Token. \n\nPrerequisites:\n1. Create or have an existing User Assigned Managed Identity in the same Azure region as the account. \n2. Create or update an Azure Map account with the same Azure region as the User Assigned Managed Identity is placed.", + "operationId": "Accounts_ListSas", + "x-ms-examples": { + "List Account Sas": { + "$ref": "./examples/AccountListSAS.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "name": "MapsAccountSasParameters", + "in": "body", + "description": "The updated parameters for the Maps Account.", + "required": true, + "schema": { + "$ref": "#/definitions/AccountSasParameters" + } + } + ], + "responses": { + "200": { + "description": "The request was successful.", + "schema": { + "$ref": "#/definitions/MapsAccountSasToken" + } + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maps/accounts/{accountName}/listKeys": { + "post": { + "tags": [ + "Accounts" + ], + "description": "Get the keys to use with the Maps APIs. A key is used to authenticate and authorize access to the Maps REST APIs. Only one key is needed at a time; two are given to provide seamless key regeneration.", + "operationId": "Accounts_ListKeys", + "x-ms-examples": { + "List Keys": { + "$ref": "./examples/ListKeys.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful.", + "schema": { + "$ref": "#/definitions/MapsAccountKeys" + } + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maps/accounts/{accountName}/regenerateKey": { + "post": { + "tags": [ + "Accounts" + ], + "description": "Regenerate either the primary or secondary key for use with the Maps APIs. The old key will stop working immediately.", + "operationId": "Accounts_RegenerateKeys", + "x-ms-examples": { + "Regenerate Key": { + "$ref": "./examples/RegenerateKey.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "name": "keySpecification", + "in": "body", + "required": true, + "description": "Which key to regenerate: primary or secondary.", + "schema": { + "$ref": "#/definitions/MapsKeySpecification" + } + } + ], + "responses": { + "200": { + "description": "The request was successful.", + "schema": { + "$ref": "#/definitions/MapsAccountKeys" + } + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Maps/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "List operations available for the Maps Resource Provider", + "operationId": "Maps_ListOperations", + "x-ms-examples": { + "Get Operations": { + "$ref": "./examples/GetOperations.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful.", + "schema": { + "$ref": "#/definitions/MapsOperations" + } + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Maps/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "List operations available for the Maps Resource Provider", + "operationId": "Maps_ListSubscriptionOperations", + "x-ms-examples": { + "Get Operations by Subscription": { + "$ref": "./examples/GetOperationsSubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful.", + "schema": { + "$ref": "#/definitions/MapsOperations" + } + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maps/accounts/{accountName}/creators": { + "get": { + "tags": [ + "Creators" + ], + "description": "Get all Creator instances for an Azure Maps Account", + "operationId": "Creators_ListByAccount", + "x-ms-examples": { + "List Creator Resources By Account": { + "$ref": "./examples/ListMapsCreatorsByAccount.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful.", + "schema": { + "$ref": "#/definitions/CreatorList" + } + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maps/accounts/{accountName}/creators/{creatorName}": { + "put": { + "tags": [ + "Creators" + ], + "description": "Create or update a Maps Creator resource. Creator resource will manage Azure resources required to populate a custom set of mapping data. It requires an account to exist before it can be created.", + "operationId": "Creators_CreateOrUpdate", + "x-ms-examples": { + "Create Creator Resource": { + "$ref": "./examples/CreateMapsCreator.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/CreatorNameParameter" + }, + { + "name": "CreatorResource", + "in": "body", + "description": "The new or updated parameters for the Creator resource.", + "required": true, + "schema": { + "$ref": "#/definitions/Creator" + } + } + ], + "responses": { + "200": { + "description": "The Creator is updated with the provided properties.", + "schema": { + "$ref": "#/definitions/Creator" + } + }, + "201": { + "description": "The Creator will be created asynchronously. The Creator will be ready to use once the provisioningState property changed to 'Succeeded' through creators Get API.", + "schema": { + "$ref": "#/definitions/Creator" + } + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Creators" + ], + "description": "Updates the Maps Creator resource. Only a subset of the parameters may be updated after creation, such as Tags.", + "operationId": "Creators_Update", + "x-ms-examples": { + "Update Creator Resource": { + "$ref": "./examples/UpdateMapsCreator.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/CreatorNameParameter" + }, + { + "name": "CreatorUpdateParameters", + "in": "body", + "description": "The update parameters for Maps Creator.", + "required": true, + "schema": { + "$ref": "#/definitions/CreatorUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The Maps Creator was successfully updated.", + "schema": { + "$ref": "#/definitions/Creator" + } + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Creators" + ], + "description": "Delete a Maps Creator resource.", + "operationId": "Creators_Delete", + "x-ms-examples": { + "Delete Creator Resource": { + "$ref": "./examples/DeleteMapsCreator.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/CreatorNameParameter" + } + ], + "responses": { + "200": { + "description": "The Maps Creator will be deleted." + }, + "204": { + "description": "The specified Maps Creator resource was not found. Nothing was deleted." + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Creators" + ], + "description": "Get a Maps Creator resource.", + "operationId": "Creators_Get", + "x-ms-examples": { + "Get Creator Resource": { + "$ref": "./examples/GetMapsCreator.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/CreatorNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful.", + "schema": { + "$ref": "#/definitions/Creator" + } + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "parameters": { + "AccountNameParameter": { + "name": "accountName", + "in": "path", + "description": "The name of the Maps Account.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "PrivateAtlasNameParameter": { + "name": "privateAtlasName", + "in": "path", + "description": "The name of the Private Atlas instance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "CreatorNameParameter": { + "name": "creatorName", + "in": "path", + "description": "The name of the Maps Creator instance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "definitions": { + "Creator": { + "description": "An Azure resource which represents Maps Creator product and provides ability to manage private location data.", + "type": "object", + "properties": { + "properties": { + "description": "The Creator resource properties.", + "$ref": "#/definitions/CreatorProperties" + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true + }, + "MapsAccount": { + "description": "An Azure resource which represents access to a suite of Maps REST APIs.", + "type": "object", + "properties": { + "sku": { + "description": "The SKU of this account.", + "$ref": "#/definitions/Sku" + }, + "kind": { + "description": "Get or Set Kind property.", + "$ref": "#/definitions/Kind" + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + }, + "identity": { + "type": "object", + "$ref": "#/definitions/ManagedServiceIdentity", + "description": "Sets the identity property for maps account." + }, + "properties": { + "description": "The map account properties.", + "$ref": "#/definitions/MapsAccountProperties" + } + }, + "required": [ + "sku" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true + }, + "MapsAccountUpdateParameters": { + "description": "Parameters used to update an existing Maps Account.", + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters." + }, + "kind": { + "description": "Get or Set Kind property.", + "$ref": "#/definitions/Kind" + }, + "sku": { + "description": "The SKU of this account.", + "$ref": "#/definitions/Sku" + }, + "identity": { + "type": "object", + "$ref": "#/definitions/ManagedServiceIdentity", + "description": "Sets the identity property for maps account." + }, + "properties": { + "description": "The map account properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/MapsAccountProperties" + } + } + }, + "CreatorUpdateParameters": { + "description": "Parameters used to update an existing Creator resource.", + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters." + }, + "properties": { + "description": "Creator resource properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/CreatorProperties" + } + } + }, + "MapsAccounts": { + "description": "A list of Maps Accounts.", + "type": "object", + "properties": { + "value": { + "description": "a Maps Account.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/MapsAccount" + } + }, + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "CreatorList": { + "description": "A list of Creator resources.", + "type": "object", + "properties": { + "value": { + "description": "a Creator account.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Creator" + } + }, + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "Kind": { + "description": "The Kind of the Maps Account.", + "type": "string", + "default": "Gen1", + "enum": [ + "Gen1", + "Gen2" + ], + "x-ms-enum": { + "name": "kind", + "modelAsString": true + } + }, + "Sku": { + "description": "The SKU of the Maps Account.", + "type": "object", + "properties": { + "name": { + "description": "The name of the SKU, in standard format (such as S0).", + "type": "string", + "enum": [ + "S0", + "S1", + "G2" + ], + "x-ms-enum": { + "name": "name", + "modelAsString": true + } + }, + "tier": { + "readOnly": true, + "type": "string", + "description": "Gets the sku tier. This is based on the SKU name." + } + }, + "required": [ + "name" + ] + }, + "MapsKeySpecification": { + "description": "Whether the operation refers to the primary or secondary key.", + "type": "object", + "required": [ + "keyType" + ], + "properties": { + "keyType": { + "type": "string", + "enum": [ + "primary", + "secondary" + ], + "x-ms-enum": { + "name": "KeyType", + "modelAsString": true + }, + "description": "Whether the operation refers to the primary or secondary key." + } + } + }, + "MapsAccountKeys": { + "description": "The set of keys which can be used to access the Maps REST APIs. Two keys are provided for key rotation without interruption.", + "type": "object", + "properties": { + "primaryKeyLastUpdated": { + "type": "string", + "readOnly": true, + "description": "The last updated date and time of the primary key." + }, + "primaryKey": { + "type": "string", + "readOnly": true, + "description": "The primary key for accessing the Maps REST APIs." + }, + "secondaryKey": { + "type": "string", + "readOnly": true, + "description": "The secondary key for accessing the Maps REST APIs." + }, + "secondaryKeyLastUpdated": { + "type": "string", + "readOnly": true, + "description": "The last updated date and time of the secondary key." + } + } + }, + "AccountSasParameters": { + "description": "Parameters used to create an account Shared Access Signature (SAS) token. The REST API access control is provided by Azure Maps Role Based Access (RBAC) identity and access.", + "type": "object", + "properties": { + "signingKey": { + "type": "string", + "description": "The Map account key to use for signing.", + "enum": [ + "primaryKey", + "secondaryKey" + ], + "x-ms-enum": { + "name": "SigningKey", + "modelAsString": true + } + }, + "principalId": { + "description": "The principal Id also known as the object Id of a User Assigned Managed Identity currently assigned to the Map Account. To assign a Managed Identity of the account, use operation Create or Update an assign a User Assigned Identity resource Id.", + "type": "string" + }, + "regions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional, allows control of which region locations are permitted access to Azure Maps REST APIs with the SAS token. Example: \"eastus\", \"westus2\". Omitting this parameter will allow all region locations to be accessible." + }, + "maxRatePerSecond": { + "type": "integer", + "minimum": 0, + "maximum": 500, + "default": 500, + "format": "int32", + "exclusiveMinimum": true, + "description": "Required parameter which represents the desired maximum request per second to allowed for the given SAS token. This does not guarantee perfect accuracy in measurements but provides application safe guards of abuse with eventual enforcement." + }, + "start": { + "description": "The date time offset of when the token validity begins. For example \"2017-05-24T10:42:03.1567373Z\".", + "type": "string" + }, + "expiry": { + "description": "The date time offset of when the token validity expires. For example \"2017-05-24T10:42:03.1567373Z\"", + "type": "string" + } + }, + "required": [ + "signingKey", + "principalId", + "maxRatePerSecond", + "start", + "expiry" + ] + }, + "MapsAccountSasToken": { + "description": "A new Sas token which can be used to access the Maps REST APIs and is controlled by the specified Managed identity permissions on Azure (IAM) Role Based Access Control.", + "type": "object", + "properties": { + "accountSasToken": { + "type": "string", + "readOnly": true, + "description": "The shared access signature access token." + } + } + }, + "ManagedServiceIdentity": { + "description": "Identity for the resource.", + "type": "object", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal ID of resource identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant ID of resource." + }, + "type": { + "type": "string", + "description": "The identity type.", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + }, + "userAssignedIdentities": { + "type": "object", + "description": "The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.", + "additionalProperties": { + "type": "object", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of user assigned identity." + }, + "clientId": { + "readOnly": true, + "type": "string", + "description": "The client id of user assigned identity." + } + } + } + } + } + }, + "MapsOperations": { + "description": "The set of operations available for Maps.", + "type": "object", + "properties": { + "value": { + "description": "An operation available for Maps.", + "type": "array", + "readOnly": true, + "uniqueItems": false, + "items": { + "$ref": "#/definitions/OperationDetail" + } + }, + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "OperationDetail": { + "description": "Operation detail payload", + "type": "object", + "properties": { + "name": { + "description": "Name of the operation", + "type": "string" + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "boolean" + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "description": "Display of the operation" + }, + "origin": { + "description": "Origin of the operation", + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OperationProperties", + "description": "Properties of the operation" + } + } + }, + "OperationDisplay": { + "description": "Operation display payload", + "type": "object", + "properties": { + "provider": { + "description": "Resource provider of the operation", + "type": "string" + }, + "resource": { + "description": "Resource of the operation", + "type": "string" + }, + "operation": { + "description": "Localized friendly name for the operation", + "type": "string" + }, + "description": { + "description": "Localized friendly description for the operation", + "type": "string" + } + } + }, + "OperationProperties": { + "description": "Properties of operation, include metric specifications.", + "type": "object", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ServiceSpecification", + "description": "One property of operation, include metric specifications." + } + } + }, + "ServiceSpecification": { + "description": "One property of operation, include metric specifications.", + "type": "object", + "properties": { + "metricSpecifications": { + "description": "Metric specifications of operation.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification" + } + } + } + }, + "MetricSpecification": { + "description": "Metric specification of operation.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of metric specification." + }, + "displayName": { + "type": "string", + "description": "Display name of metric specification." + }, + "displayDescription": { + "type": "string", + "description": "Display description of metric specification." + }, + "unit": { + "type": "string", + "description": "Unit could be Count." + }, + "dimensions": { + "description": "Dimensions of map account.", + "type": "array", + "items": { + "$ref": "#/definitions/Dimension" + } + }, + "aggregationType": { + "type": "string", + "description": "Aggregation type could be Average." + }, + "fillGapWithZero": { + "type": "boolean", + "description": "The property to decide fill gap with zero or not." + }, + "category": { + "type": "string", + "description": "The category this metric specification belong to, could be Capacity." + }, + "resourceIdDimensionNameOverride": { + "type": "string", + "description": "Account Resource Id." + }, + "sourceMdmAccount": { + "type": "string", + "description": "Source metrics account." + }, + "internalMetricName": { + "type": "string", + "description": "Internal metric name." + } + } + }, + "Dimension": { + "description": "Dimension of map account, for example API Category, Api Name, Result Type, and Response Code.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Display name of dimension." + }, + "displayName": { + "type": "string", + "description": "Display name of dimension." + }, + "internalName": { + "type": "string", + "description": "Internal name of the dimension." + }, + "internalMetricName": { + "type": "string", + "description": "Internal metric name of the dimension." + }, + "sourceMdmNamespace": { + "type": "string", + "description": "Source Mdm Namespace of the dimension." + }, + "toBeExportedToShoebox": { + "type": "boolean", + "description": "Flag to indicate exporting to Azure Monitor." + } + } + }, + "MapsAccountProperties": { + "description": "Additional Map account properties", + "type": "object", + "properties": { + "uniqueId": { + "description": "A unique identifier for the maps account", + "type": "string", + "readOnly": true + }, + "disableLocalAuth": { + "description": "Allows toggle functionality on Azure Policy to disable Azure Maps local authentication support. This will disable Shared Keys authentication from any usage.", + "type": "boolean", + "default": false + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state of the Map account resource.", + "readOnly": true + }, + "linkedResources": { + "type": "array", + "$ref": "#/definitions/LinkedResources", + "description": "Sets the resources to be used for Managed Identities based operations for the Map account resource." + }, + "cors": { + "$ref": "#/definitions/CorsRules", + "description": "Specifies CORS rules for the Blob service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the Blob service." + } + } + }, + "LinkedResources": { + "type": "array", + "maxItems": 10, + "items": { + "$ref": "#/definitions/LinkedResource" + }, + "description": "The array of associated resources to the Map account. Linked resource in the array cannot individually update, you must update all linked resources in the array together. These resources may be used on operations on the Azure Maps REST API. Access is controlled by the Map Account Managed Identity(s) permissions to those resource(s)." + }, + "LinkedResource": { + "type": "object", + "properties": { + "uniqueName": { + "type": "string", + "description": "A provided name which uniquely identifies the linked resource." + }, + "id": { + "type": "string", + "description": "ARM resource id in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/accounts/{storageName}'." + } + }, + "required": [ + "uniqueName", + "id" + ], + "description": "Linked resource is reference to a resource deployed in an Azure subscription, add the linked resource `uniqueName` value as an optional parameter for operations on Azure Maps Geospatial REST APIs." + }, + "CorsRules": { + "type": "object", + "properties": { + "corsRules": { + "type": "array", + "maxItems": 5, + "items": { + "description": "Specifies a CORS rule for the Map Account.", + "$ref": "#/definitions/CorsRule" + }, + "description": "The list of CORS rules. You can include up to five CorsRule elements in the request. " + } + }, + "description": "Sets the CORS rules. You can include up to five CorsRule elements in the request. " + }, + "CorsRule": { + "type": "object", + "properties": { + "allowedOrigins": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or \"*\" to allow all domains" + } + }, + "required": [ + "allowedOrigins" + ], + "description": "Specifies a CORS rule for the Map Account." + }, + "CreatorProperties": { + "description": "Creator resource properties", + "type": "object", + "properties": { + "provisioningState": { + "description": "The state of the resource provisioning, terminal states: Succeeded, Failed, Canceled", + "type": "string", + "readOnly": true + }, + "storageUnits": { + "description": "The storage units to be allocated. Integer values from 1 to 100, inclusive.", + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "storageUnits" + ] + } + } +} diff --git a/specification/maps/resource-manager/readme.md b/specification/maps/resource-manager/readme.md index dd4f68353760..0760169b6b01 100644 --- a/specification/maps/resource-manager/readme.md +++ b/specification/maps/resource-manager/readme.md @@ -28,18 +28,27 @@ These are the global settings for the Maps API. title: AzureMapsManagementClient description: Azure Maps openapi-type: arm -tag: package-preview-2021-07 +tag: package-preview-2021-12 ``` +### Tag: package-preview-2021-12 + +These settings apply only when `--tag=package-preview-2021-12` is specified on the command line. + +```yaml $(tag) == 'package-preview-2021-12' +input-file: + - Microsoft.Maps/preview/2021-12-01-preview/maps-management.json +``` ### Tag: package-preview-2021-07 These settings apply only when `--tag=package-preview-2021-07` is specified on the command line. -```yaml $(tag) == 'package-preview-2021-07' +``` yaml $(tag) == 'package-preview-2021-07' input-file: - Microsoft.Maps/preview/2021-07-01-preview/maps-management.json ``` + ### Tag: package-2021-02 These settings apply only when `--tag=package-2021-02` is specified on the command line. @@ -206,6 +215,7 @@ directive: - suppress: R3006 where: - $.definitions.MapsAccount.properties + - $.definitions.Creator.properties reason: - Currently systemData is not allowed. - suppress: R3010 From 330702f6561bceb832d51f0a65090c0652f8ca9b Mon Sep 17 00:00:00 2001 From: uratzmon <81904834+uratzmon@users.noreply.github.com> Date: Fri, 29 Oct 2021 04:37:20 +0300 Subject: [PATCH 14/19] Feature/uratzmon/2021 10 27 preview (#16566) * Add blockchain to latest profile * Add additional types * copy paste the last version * replace the version string where necessary * add examples files * add new APIs * fix checks #1 * Update specification/vi/resource-manager/readme.md * delete unnecessary part Co-authored-by: Mark Cowlishaw Co-authored-by: Yuchao Yan --- custom-words.txt | 1 + .../ViAccountCheckNameAvailabilityFree.json | 17 + .../ViAccountCheckNameAvailabilityTaken.json | 19 + .../examples/ViAccountDelete.json | 21 + .../examples/ViAccountGet.json | 38 + .../ViAccountPatch/ViAccountPatch1.json | 75 + .../ViAccountPatch/ViAccountPatch2.json | 75 + .../ViAccountPatch/ViAccountPatch3.json | 75 + .../ViAccountPatch/ViAccountPatch4.json | 75 + .../ViAccountPatch/ViAccountPatch5.json | 75 + .../ViAccountPatch/ViAccountPatch6.json | 42 + .../ViAccountPatch/ViAccountPatch7.json | 49 + .../ViAccountPatch/ViAccountPatch8.json | 50 + .../examples/ViAccountPut/ViAccountPut1.json | 85 ++ .../examples/ViAccountPut/ViAccountPut10.json | 55 + .../examples/ViAccountPut/ViAccountPut2.json | 85 ++ .../examples/ViAccountPut/ViAccountPut3.json | 85 ++ .../examples/ViAccountPut/ViAccountPut4.json | 85 ++ .../examples/ViAccountPut/ViAccountPut5.json | 85 ++ .../examples/ViAccountPut/ViAccountPut6.json | 85 ++ .../examples/ViAccountPut/ViAccountPut7.json | 85 ++ .../examples/ViAccountPut/ViAccountPut8.json | 56 + .../examples/ViAccountPut/ViAccountPut9.json | 43 + .../examples/ViAccountsList.json | 41 + .../ViAccountsListByResourceGroup.json | 42 + .../examples/ViClassicAccounts.json | 57 + ...GenerateAccountContributerAccessToken.json | 46 + .../ViGenerateAccountReaderAccessToken.json | 46 + ...enerateProjectContributerAccessToken1.json | 52 + ...enerateProjectContributerAccessToken2.json | 52 + .../ViGenerateProjectReaderAccessToken1.json | 52 + .../ViGenerateProjectReaderAccessToken2.json | 52 + ...iGenerateVideoContributerAccessToken1.json | 52 + ...iGenerateVideoContributerAccessToken2.json | 52 + .../ViGenerateVideoReaderAccessToken1.json | 52 + .../ViGenerateVideoReaderAccessToken2.json | 52 + .../examples/ViListUserClassicAccounts.json | 27 + .../examples/ViOperationsList.json | 40 + .../preview/2021-10-27-preview/vi.json | 1250 +++++++++++++++++ .../vi/resource-manager/readme.design.md | 2 +- .../vi/resource-manager/readme.go.md | 1 + specification/vi/resource-manager/readme.md | 18 +- .../vi/resource-manager/readme.terraform.md | 4 + 43 files changed, 3348 insertions(+), 3 deletions(-) create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountCheckNameAvailabilityFree.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountCheckNameAvailabilityTaken.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountDelete.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountGet.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPatch/ViAccountPatch1.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPatch/ViAccountPatch2.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPatch/ViAccountPatch3.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPatch/ViAccountPatch4.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPatch/ViAccountPatch5.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPatch/ViAccountPatch6.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPatch/ViAccountPatch7.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPatch/ViAccountPatch8.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPut/ViAccountPut1.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPut/ViAccountPut10.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPut/ViAccountPut2.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPut/ViAccountPut3.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPut/ViAccountPut4.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPut/ViAccountPut5.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPut/ViAccountPut6.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPut/ViAccountPut7.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPut/ViAccountPut8.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPut/ViAccountPut9.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountsList.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountsListByResourceGroup.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViClassicAccounts.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViGenerateAccessToken/ViGenerateAccountContributerAccessToken.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViGenerateAccessToken/ViGenerateAccountReaderAccessToken.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViGenerateAccessToken/ViGenerateProjectContributerAccessToken1.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViGenerateAccessToken/ViGenerateProjectContributerAccessToken2.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViGenerateAccessToken/ViGenerateProjectReaderAccessToken1.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViGenerateAccessToken/ViGenerateProjectReaderAccessToken2.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViGenerateAccessToken/ViGenerateVideoContributerAccessToken1.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViGenerateAccessToken/ViGenerateVideoContributerAccessToken2.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViGenerateAccessToken/ViGenerateVideoReaderAccessToken1.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViGenerateAccessToken/ViGenerateVideoReaderAccessToken2.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViListUserClassicAccounts.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViOperationsList.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/vi.json diff --git a/custom-words.txt b/custom-words.txt index f8be822eecfc..e7393e7224cc 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -2418,3 +2418,4 @@ stackset CSPM autoprovisioning schemagroups +videoanalyzer \ No newline at end of file diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountCheckNameAvailabilityFree.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountCheckNameAvailabilityFree.json new file mode 100644 index 000000000000..fe8d4248726a --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountCheckNameAvailabilityFree.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2021-10-27-preview", + "subscriptionId": "586d4f48-8f08-4a4e-96b7-e1892d6dba9e", + "checkNameAvailabilityParameters": { + "name": "vi1", + "type": "Microsoft.VideoIndexer/accounts" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountCheckNameAvailabilityTaken.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountCheckNameAvailabilityTaken.json new file mode 100644 index 000000000000..0b1b9fa458fe --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountCheckNameAvailabilityTaken.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2021-10-27-preview", + "subscriptionId": "586d4f48-8f08-4a4e-96b7-e1892d6dba9e", + "checkNameAvailabilityParameters": { + "name": "vi1", + "type": "Microsoft.VideoIndexer/accounts" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "AlreadyExists", + "message": "Resource name already exists" + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountDelete.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountDelete.json new file mode 100644 index 000000000000..5e3954f00ee9 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountDelete.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contoso-rg", + "api-version": "2021-10-27-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3" + }, + "responses": { + "200": {}, + "202": {}, + "204": {}, + "500": { + "body": { + "error": { + "code": "GENERAL", + "message": "Trace id: '9677927b-ae6b-496g-1df8-9ec3048b4bf2'." + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountGet.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountGet.json new file mode 100644 index 000000000000..1ec928b03036 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountGet.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contoso-rg", + "api-version": "2021-10-27-preview", + "subscriptionId": "586d4f48-8f08-4a4e-96b7-e1892d6dba9e" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contoso-videoanalyzer", + "name": "vi1", + "type": "Microsoft.VideoIndexer/accounts", + "location": "NorthEurope", + "tags": {}, + "properties": { + "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e", + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "accountName": "contosto-videoanalyzer", + "mediaServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Media/mediaservices/contoso-videoanalyzer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + }, + "provisioningState": "Succeeded" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": { + "principalId": "a661c16c-ee39-46e7-93f6-7fb80d17ef13", + "clientId": "92e65ecf-0fae-432e-8272-fedb6edb96c7" + } + } + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPatch/ViAccountPatch1.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPatch/ViAccountPatch1.json new file mode 100644 index 000000000000..a115e849daf6 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPatch/ViAccountPatch1.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2021-10-27-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "properties": { + "mediaServices": { + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoanalyzer", + "name": "contosto-videoanalyzer", + "location": "NorthEurope", + "type": "Microsoft.VideoIndexer/accounts", + "tags": {}, + "properties": { + "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e", + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "accountName": "contosto-videoanalyzer", + "mediaServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Media/mediaservices/contoso-videoanalyzer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + }, + "provisioningState": "Succeeded" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": { + "principalId": "a661c16c-ee39-46e7-93f6-7fb80d17ef13", + "clientId": "92e65ecf-0fae-432e-8272-fedb6edb96c7" + } + } + } + } + }, + "400": { + "body": { + "error": { + "code": "EVENT_GRID_NOT_REGISTERED", + "message": "Microsoft.EventGrid resource provider is not registered in subscription" + } + } + }, + "404": { + "body": { + "error": { + "code": "ACCOUNT_NOT_FOUND", + "message": "Account not found" + } + } + }, + "500": { + "body": { + "error": { + "code": "GENERAL", + "message": "Trace id: '9677927b-ae6b-496g-1df8-9ec3048b4bf2'." + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPatch/ViAccountPatch2.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPatch/ViAccountPatch2.json new file mode 100644 index 000000000000..1fa2255b1bff --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPatch/ViAccountPatch2.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2021-10-27-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "properties": { + "mediaServices": { + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoanalyzer", + "name": "contosto-videoanalyzer", + "location": "NorthEurope", + "type": "Microsoft.VideoIndexer/accounts", + "tags": {}, + "properties": { + "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e", + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "accountName": "contosto-videoanalyzer", + "mediaServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Media/mediaservices/contoso-videoanalyzer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + }, + "provisioningState": "Succeeded" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": { + "principalId": "a661c16c-ee39-46e7-93f6-7fb80d17ef13", + "clientId": "92e65ecf-0fae-432e-8272-fedb6edb96c7" + } + } + } + } + }, + "400": { + "body": { + "error": { + "code": "AMS_IN_ANOTHER_LOCATION", + "message": "Can not connect to a Media Services account which is not in the same location as the VideoIndexer account" + } + } + }, + "404": { + "body": { + "error": { + "code": "ACCOUNT_NOT_FOUND", + "message": "Account not found" + } + } + }, + "500": { + "body": { + "error": { + "code": "GENERAL", + "message": "Trace id: '9677927b-ae6b-496g-1df8-9ec3048b4bf2'." + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPatch/ViAccountPatch3.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPatch/ViAccountPatch3.json new file mode 100644 index 000000000000..457875168d37 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPatch/ViAccountPatch3.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2021-10-27-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "properties": { + "mediaServices": { + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoanalyzer", + "name": "contosto-videoanalyzer", + "location": "NorthEurope", + "type": "Microsoft.VideoIndexer/accounts", + "tags": {}, + "properties": { + "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e", + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "accountName": "contosto-videoanalyzer", + "mediaServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Media/mediaservices/contoso-videoanalyzer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + }, + "provisioningState": "Succeeded" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": { + "principalId": "a661c16c-ee39-46e7-93f6-7fb80d17ef13", + "clientId": "92e65ecf-0fae-432e-8272-fedb6edb96c7" + } + } + } + } + }, + "400": { + "body": { + "error": { + "code": "AMS_UNREACHABLE", + "message": "Failed to connect to Media Services account" + } + } + }, + "404": { + "body": { + "error": { + "code": "ACCOUNT_NOT_FOUND", + "message": "Account not found" + } + } + }, + "500": { + "body": { + "error": { + "code": "GENERAL", + "message": "Trace id: '9677927b-ae6b-496g-1df8-9ec3048b4bf2'." + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPatch/ViAccountPatch4.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPatch/ViAccountPatch4.json new file mode 100644 index 000000000000..2e6f5864f076 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPatch/ViAccountPatch4.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2021-10-27-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "properties": { + "mediaServices": { + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoanalyzer", + "name": "contosto-videoanalyzer", + "location": "NorthEurope", + "type": "Microsoft.VideoIndexer/accounts", + "tags": {}, + "properties": { + "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e", + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "accountName": "contosto-videoanalyzer", + "mediaServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Media/mediaservices/contoso-videoanalyzer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + }, + "provisioningState": "Succeeded" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": { + "principalId": "a661c16c-ee39-46e7-93f6-7fb80d17ef13", + "clientId": "92e65ecf-0fae-432e-8272-fedb6edb96c7" + } + } + } + } + }, + "400": { + "body": { + "error": { + "code": "AMS_INVALID_AAD_CONNECTION", + "message": "Cannot connect to resource '{AadConnectionConfig.AmsResourceUri}' due to issue with AAD application '{AadConnectionConfig.AadApplicationId}' that should have permissions to it.'" + } + } + }, + "404": { + "body": { + "error": { + "code": "ACCOUNT_NOT_FOUND", + "message": "Account not found" + } + } + }, + "500": { + "body": { + "error": { + "code": "GENERAL", + "message": "Trace id: '9677927b-ae6b-496g-1df8-9ec3048b4bf2'." + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPatch/ViAccountPatch5.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPatch/ViAccountPatch5.json new file mode 100644 index 000000000000..e2c5a5eea4c5 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPatch/ViAccountPatch5.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2021-10-27-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "properties": { + "mediaServices": { + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoanalyzer", + "name": "contosto-videoanalyzer", + "location": "NorthEurope", + "type": "Microsoft.VideoIndexer/accounts", + "tags": {}, + "properties": { + "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e", + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "accountName": "contosto-videoanalyzer", + "mediaServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Media/mediaservices/contoso-videoanalyzer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + }, + "provisioningState": "Succeeded" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": { + "principalId": "a661c16c-ee39-46e7-93f6-7fb80d17ef13", + "clientId": "92e65ecf-0fae-432e-8272-fedb6edb96c7" + } + } + } + } + }, + "400": { + "body": { + "error": { + "code": "AMS_AAD_APPLICATION_INSUFFICIENT_PERMISSION", + "message": "The AAD application is Unauthorized. Make sure it has at least 'Contributor' permissions" + } + } + }, + "404": { + "body": { + "error": { + "code": "ACCOUNT_NOT_FOUND", + "message": "Account not found" + } + } + }, + "500": { + "body": { + "error": { + "code": "GENERAL", + "message": "Trace id: '9677927b-ae6b-496g-1df8-9ec3048b4bf2'." + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPatch/ViAccountPatch6.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPatch/ViAccountPatch6.json new file mode 100644 index 000000000000..ffb68601db1b --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPatch/ViAccountPatch6.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2021-10-27-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoanalyzer", + "name": "contosto-videoanalyzer", + "location": "NorthEurope", + "type": "Microsoft.VideoIndexer/accounts", + "tags": {}, + "properties": {} + } + }, + "400": { + "body": { + "error": { + "code": "InvalidResource", + "message": "The resource definition is invalid." + } + } + }, + "404": { + "body": { + "error": {} + } + }, + "500": { + "body": { + "error": { + "code": "GENERAL", + "message": "Trace id: '9677927b-ae6b-496g-1df8-9ec3048b4bf2'." + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPatch/ViAccountPatch7.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPatch/ViAccountPatch7.json new file mode 100644 index 000000000000..4c4248bf0ff5 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPatch/ViAccountPatch7.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2021-10-27-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoanalyzer", + "name": "contosto-videoanalyzer", + "location": "NorthEurope", + "type": "Microsoft.VideoIndexer/accounts", + "tags": {}, + "properties": {} + } + }, + "400": { + "body": { + "error": {} + } + }, + "404": { + "body": { + "error": { + "code": "ResourceNotFound", + "message": "The Resource 'contosto-videoanalyzer' under resource group 'contosto-videoanalyzer-rg' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix" + } + } + }, + "500": { + "body": { + "error": { + "code": "GENERAL", + "message": "Trace id: '9677927b-ae6b-496g-1df8-9ec3048b4bf2'." + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPatch/ViAccountPatch8.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPatch/ViAccountPatch8.json new file mode 100644 index 000000000000..ba3d888f123b --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPatch/ViAccountPatch8.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2021-10-27-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "properties": { + "mediaServices": { + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": {} + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoanalyzer", + "name": "contosto-videoanalyzer", + "location": "NorthEurope", + "type": "Microsoft.VideoIndexer/accounts", + "tags": {}, + "properties": {} + } + }, + "400": { + "body": { + "error": { + "code": "MissingIdentityIds", + "message": "The identity ids must not be null or empty for 'UserAssigned' identity type." + } + } + }, + "404": { + "body": {} + }, + "500": { + "body": { + "error": { + "code": "GENERAL", + "message": "Trace id: '9677927b-ae6b-496g-1df8-9ec3048b4bf2'." + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPut/ViAccountPut1.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPut/ViAccountPut1.json new file mode 100644 index 000000000000..f01f945be529 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPut/ViAccountPut1.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2021-10-27-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "location": "NorthEurope", + "properties": { + "mediaServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Media/mediaservices/contoso-videoanalyzer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoanalyzer", + "name": "contosto-videoanalyzer", + "location": "NorthEurope", + "type": "Microsoft.VideoIndexer/accounts", + "tags": {}, + "properties": { + "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e", + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "accountName": "contosto-videoanalyzer", + "mediaServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Media/mediaservices/contoso-videoanalyzer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + }, + "provisioningState": "Succeeded" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": { + "principalId": "a661c16c-ee39-46e7-93f6-7fb80d17ef13", + "clientId": "92e65ecf-0fae-432e-8272-fedb6edb96c7" + } + } + } + } + }, + "400": { + "body": { + "error": { + "code": "EVENT_GRID_NOT_REGISTERED", + "message": "Microsoft.EventGrid resource provider is not registered in subscription" + } + } + }, + "404": { + "body": { + "error": { + "code": "ACCOUNT_NOT_FOUND", + "message": "Account not found" + } + } + }, + "409": { + "body": { + "error": { + "code": "ALREADY_EXISTS", + "message": "Account with '74f866ea-f74f-4103-a916-4742f8bc0009' already exists" + } + } + }, + "500": { + "body": { + "error": { + "code": "GENERAL", + "message": "Trace id: '9677927b-ae6b-496g-1df8-9ec3048b4bf2'." + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPut/ViAccountPut10.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPut/ViAccountPut10.json new file mode 100644 index 000000000000..1de1f97d679d --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPut/ViAccountPut10.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2021-10-27-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "location": "NorthEurope", + "properties": { + "mediaServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Media/mediaservices/contoso-videoanalyzer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": {} + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoanalyzer", + "name": "contosto-videoanalyzer", + "location": "NorthEurope", + "type": "Microsoft.VideoIndexer/accounts", + "tags": {}, + "properties": {} + } + }, + "400": { + "body": { + "error": { + "code": "MissingIdentityIds", + "message": "The identity ids must not be null or empty for 'UserAssigned' identity type." + } + } + }, + "404": { + "body": {} + }, + "409": { + "body": {} + }, + "500": { + "body": { + "error": { + "code": "GENERAL", + "message": "Trace id: '9677927b-ae6b-496g-1df8-9ec3048b4bf2'." + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPut/ViAccountPut2.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPut/ViAccountPut2.json new file mode 100644 index 000000000000..0c8071d18210 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPut/ViAccountPut2.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2021-10-27-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "location": "NorthEurope", + "properties": { + "mediaServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Media/mediaservices/contoso-videoanalyzer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoanalyzer", + "name": "contosto-videoanalyzer", + "location": "NorthEurope", + "type": "Microsoft.VideoIndexer/accounts", + "tags": {}, + "properties": { + "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e", + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "accountName": "contosto-videoanalyzer", + "mediaServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Media/mediaservices/contoso-videoanalyzer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + }, + "provisioningState": "Succeeded" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": { + "principalId": "a661c16c-ee39-46e7-93f6-7fb80d17ef13", + "clientId": "92e65ecf-0fae-432e-8272-fedb6edb96c7" + } + } + } + } + }, + "400": { + "body": { + "error": { + "code": "AMS_IN_ANOTHER_LOCATION", + "message": "Can not connect to a Media Services account which is not in the same location as the VideoIndexer account" + } + } + }, + "404": { + "body": { + "error": { + "code": "ACCOUNT_NOT_FOUND", + "message": "Account not found" + } + } + }, + "409": { + "body": { + "error": { + "code": "ALREADY_EXISTS", + "message": "Account with '74f866ea-f74f-4103-a916-4742f8bc0009' already exists" + } + } + }, + "500": { + "body": { + "error": { + "code": "GENERAL", + "message": "Trace id: '9677927b-ae6b-496g-1df8-9ec3048b4bf2'." + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPut/ViAccountPut3.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPut/ViAccountPut3.json new file mode 100644 index 000000000000..2fa23edce292 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPut/ViAccountPut3.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2021-10-27-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "location": "NorthEurope", + "properties": { + "mediaServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Media/mediaservices/contoso-videoanalyzer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoanalyzer", + "name": "contosto-videoanalyzer", + "location": "NorthEurope", + "type": "Microsoft.VideoIndexer/accounts", + "tags": {}, + "properties": { + "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e", + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "accountName": "contosto-videoanalyzer", + "mediaServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Media/mediaservices/contoso-videoanalyzer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + }, + "provisioningState": "Succeeded" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": { + "principalId": "a661c16c-ee39-46e7-93f6-7fb80d17ef13", + "clientId": "92e65ecf-0fae-432e-8272-fedb6edb96c7" + } + } + } + } + }, + "400": { + "body": { + "error": { + "code": "AMS_UNREACHABLE", + "message": "Failed to connect to Media Services account" + } + } + }, + "404": { + "body": { + "error": { + "code": "ACCOUNT_NOT_FOUND", + "message": "Account not found" + } + } + }, + "409": { + "body": { + "error": { + "code": "ALREADY_EXISTS", + "message": "Account with '74f866ea-f74f-4103-a916-4742f8bc0009' already exists" + } + } + }, + "500": { + "body": { + "error": { + "code": "GENERAL", + "message": "Trace id: '9677927b-ae6b-496g-1df8-9ec3048b4bf2'." + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPut/ViAccountPut4.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPut/ViAccountPut4.json new file mode 100644 index 000000000000..24e7f6cb198b --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPut/ViAccountPut4.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2021-10-27-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "location": "NorthEurope", + "properties": { + "mediaServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Media/mediaservices/contoso-videoanalyzer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoanalyzer", + "name": "contosto-videoanalyzer", + "location": "NorthEurope", + "type": "Microsoft.VideoIndexer/accounts", + "tags": {}, + "properties": { + "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e", + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "accountName": "contosto-videoanalyzer", + "mediaServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Media/mediaservices/contoso-videoanalyzer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + }, + "provisioningState": "Succeeded" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": { + "principalId": "a661c16c-ee39-46e7-93f6-7fb80d17ef13", + "clientId": "92e65ecf-0fae-432e-8272-fedb6edb96c7" + } + } + } + } + }, + "400": { + "body": { + "error": { + "code": "AMS_AAD_APPLICATION_INSUFFICIENT_PERMISSION", + "message": "The AAD application is Unauthorized. Make sure it has at least 'Contributor' permissions" + } + } + }, + "404": { + "body": { + "error": { + "code": "ACCOUNT_NOT_FOUND", + "message": "Account not found" + } + } + }, + "409": { + "body": { + "error": { + "code": "ALREADY_EXISTS", + "message": "Account with '74f866ea-f74f-4103-a916-4742f8bc0009' already exists" + } + } + }, + "500": { + "body": { + "error": { + "code": "GENERAL", + "message": "Trace id: '9677927b-ae6b-496g-1df8-9ec3048b4bf2'." + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPut/ViAccountPut5.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPut/ViAccountPut5.json new file mode 100644 index 000000000000..29b5a328be7d --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPut/ViAccountPut5.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2021-10-27-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "location": "NorthEurope", + "properties": { + "mediaServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Media/mediaservices/contoso-videoanalyzer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoanalyzer", + "name": "contosto-videoanalyzer", + "location": "NorthEurope", + "type": "Microsoft.VideoIndexer/accounts", + "tags": {}, + "properties": { + "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e", + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "accountName": "contosto-videoanalyzer", + "mediaServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Media/mediaservices/contoso-videoanalyzer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + }, + "provisioningState": "Succeeded" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": { + "principalId": "a661c16c-ee39-46e7-93f6-7fb80d17ef13", + "clientId": "92e65ecf-0fae-432e-8272-fedb6edb96c7" + } + } + } + } + }, + "400": { + "body": { + "error": { + "code": "AMS_INVALID_AAD_CONNECTION", + "message": "Cannot connect to resource '{AadConnectionConfig.AmsResourceUri}' due to issue with AAD application '{AadConnectionConfig.AadApplicationId}' that should have permissions to it.'" + } + } + }, + "404": { + "body": { + "error": { + "code": "ACCOUNT_NOT_FOUND", + "message": "Account not found" + } + } + }, + "409": { + "body": { + "error": { + "code": "ALREADY_EXISTS", + "message": "Account with '74f866ea-f74f-4103-a916-4742f8bc0009' already exists" + } + } + }, + "500": { + "body": { + "error": { + "code": "GENERAL", + "message": "Trace id: '9677927b-ae6b-496g-1df8-9ec3048b4bf2'." + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPut/ViAccountPut6.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPut/ViAccountPut6.json new file mode 100644 index 000000000000..f0b69906810d --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPut/ViAccountPut6.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2021-10-27-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "location": "NorthEurope", + "properties": { + "mediaServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Media/mediaservices/contoso-videoanalyzer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoanalyzer", + "name": "contosto-videoanalyzer", + "location": "NorthEurope", + "type": "Microsoft.VideoIndexer/accounts", + "tags": {}, + "properties": { + "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e", + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "accountName": "contosto-videoanalyzer", + "mediaServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Media/mediaservices/contoso-videoanalyzer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + }, + "provisioningState": "Succeeded" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": { + "principalId": "a661c16c-ee39-46e7-93f6-7fb80d17ef13", + "clientId": "92e65ecf-0fae-432e-8272-fedb6edb96c7" + } + } + } + } + }, + "400": { + "body": { + "error": { + "code": "EVENT_GRID_NOT_REGISTERED", + "message": "Microsoft.EventGrid resource provider is not registered in subscription" + } + } + }, + "404": { + "body": { + "error": { + "code": "ACCOUNT_NOT_FOUND", + "message": "Account not found" + } + } + }, + "409": { + "body": { + "error": { + "code": "InvalidResourceLocation", + "message": "The resource 'xxx' already exists in location 'xxx' in resource group 'xxx'. A resource with the same name cannot be created in location 'xxx'. Please select a new resource name." + } + } + }, + "500": { + "body": { + "error": { + "code": "GENERAL", + "message": "Trace id: '9677927b-ae6b-496g-1df8-9ec3048b4bf2'." + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPut/ViAccountPut7.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPut/ViAccountPut7.json new file mode 100644 index 000000000000..c3f84f207108 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPut/ViAccountPut7.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2021-10-27-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "location": "NorthEurope", + "properties": { + "mediaServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Media/mediaservices/contoso-videoanalyzer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoanalyzer", + "name": "contosto-videoanalyzer", + "location": "NorthEurope", + "type": "Microsoft.VideoIndexer/accounts", + "tags": {}, + "properties": { + "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e", + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "accountName": "contosto-videoanalyzer", + "mediaServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Media/mediaservices/contoso-videoanalyzer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + }, + "provisioningState": "Succeeded" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": { + "principalId": "a661c16c-ee39-46e7-93f6-7fb80d17ef13", + "clientId": "92e65ecf-0fae-432e-8272-fedb6edb96c7" + } + } + } + } + }, + "400": { + "body": { + "error": { + "code": "EVENT_GRID_NOT_REGISTERED", + "message": "Microsoft.EventGrid resource provider is not registered in subscription" + } + } + }, + "404": { + "body": { + "error": { + "code": "RersourceGroupNotFound", + "message": "Resource group 'contosto-videoanalyzer-rg' could not be found." + } + } + }, + "409": { + "body": { + "error": { + "code": "ALREADY_EXISTS", + "message": "Account with '74f866ea-f74f-4103-a916-4742f8bc0009' already exists" + } + } + }, + "500": { + "body": { + "error": { + "code": "GENERAL", + "message": "Trace id: '9677927b-ae6b-496g-1df8-9ec3048b4bf2'." + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPut/ViAccountPut8.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPut/ViAccountPut8.json new file mode 100644 index 000000000000..adf57abc84cc --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPut/ViAccountPut8.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2021-10-27-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "location": "NorthEurope", + "properties": { + "mediaServices": { + "resourceId": "/subscriptions/24237b72-8546-4da5-b204-8c3cb76dd930/resourceGroups/uratzmon-rg/providers/Microsoft.Media/mediaservices/talshoham" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "subscriptions/24237b72-8546-4da5-b204-8c3cb76dd930/resourceGroups/uratzmon-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/talshoham": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoanalyzer", + "name": "contosto-videoanalyzer", + "location": "NorthEurope", + "type": "Microsoft.VideoIndexer/accounts", + "tags": {}, + "properties": {} + } + }, + "400": { + "body": { + "error": { + "code": "INVALID_INPUT", + "message": "UserAssignedIdentity is empty. Trace id:'9677927b-ae6b-496g-1df8-9ec3048b4bf2'" + } + } + }, + "404": { + "body": {} + }, + "409": { + "body": {} + }, + "500": { + "body": { + "error": { + "code": "GENERAL", + "message": "Trace id: '9677927b-ae6b-496g-1df8-9ec3048b4bf2'." + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPut/ViAccountPut9.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPut/ViAccountPut9.json new file mode 100644 index 000000000000..c23b4f0311f5 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountPut/ViAccountPut9.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2021-10-27-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoanalyzer", + "name": "contosto-videoanalyzer", + "location": "NorthEurope", + "type": "Microsoft.VideoIndexer/accounts", + "tags": {}, + "properties": {} + } + }, + "400": { + "body": { + "error": { + "code": "InvalidResource", + "message": "The resource definition is invalid." + } + } + }, + "404": { + "body": {} + }, + "409": { + "body": {} + }, + "500": { + "body": { + "error": { + "code": "GENERAL", + "message": "Trace id: '9677927b-ae6b-496g-1df8-9ec3048b4bf2'." + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountsList.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountsList.json new file mode 100644 index 000000000000..e8392b7727ca --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountsList.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2021-10-27-preview", + "subscriptionId": "586d4f48-8f08-4a4e-96b7-e1892d6dba9e" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contoso-videoanalyzer", + "name": "vi1", + "type": "Microsoft.VideoIndexer/accounts", + "location": "NorthEurope", + "tags": {}, + "properties": { + "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e", + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "accountName": "contosto-videoanalyzer", + "mediaServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Media/mediaservices/contoso-videoanalyzer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + }, + "provisioningState": "Provisioning" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": { + "principalId": "a661c16c-ee39-46e7-93f6-7fb80d17ef13", + "clientId": "92e65ecf-0fae-432e-8272-fedb6edb96c7" + } + } + } + } + ], + "nextLink": "link" + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountsListByResourceGroup.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountsListByResourceGroup.json new file mode 100644 index 000000000000..529ed657e126 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViAccountsListByResourceGroup.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "resourceGroupName": "contoso-videoanalyzer-rg", + "api-version": "2021-10-27-preview", + "subscriptionId": "586d4f48-8f08-4a4e-96b7-e1892d6dba9e" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contoso-videoanalyzer-rg", + "name": "vi1", + "type": "Microsoft.VideoIndexer/accounts", + "location": "NorthEurope", + "tags": {}, + "properties": { + "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e", + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "accountName": "contosto-videoanalyzer", + "mediaServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Media/mediaservices/contoso-videoanalyzer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + }, + "provisioningState": "Succeeded" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": { + "principalId": "a661c16c-ee39-46e7-93f6-7fb80d17ef13", + "clientId": "92e65ecf-0fae-432e-8272-fedb6edb96c7" + } + } + } + } + ], + "nextLink": "link" + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViClassicAccounts.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViClassicAccounts.json new file mode 100644 index 000000000000..3a243906aed8 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViClassicAccounts.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2021-10-01-preview", + "location": "NorthEurope", + "accountName": "contosto-videoanalyzer" + }, + "responses": { + "200": { + "body": { + "name": "contosto-videoanalyzer", + "location": "NorthEurope", + "mediaServices": { + "aadApplicationId": "912f96dc-1ed3-4d7d-aa67-0adef4bb68ad", + "aadTenantId": "72f988bf-86f1-41ag-91ab-2d7cd061db47", + "connected": true, + "eventGridProviderRegistered": true, + "name": "contosoVideoanalyzerMediaServices", + "resourceGroup": "contoso-videoanalyzer-rg", + "streamingEndpointStarted": false, + "subscriptionId": "586d4f48-8f08-4a4e-96b7-e1892d6dba9e" + } + } + }, + "400": { + "body": { + "error": { + "code": "INVALID_INPUT", + "message": "AccountName is empty" + } + } + }, + "401": { + "body": { + "error": { + "code": "USER_NOT_ALLOWED", + "message": "User is not account owner for account - contoso-videoanalyzer" + } + } + }, + "404": { + "body": { + "error": { + "code": "ACCOUNT_NOT_FOUND", + "message": "Classic account not found or has been deleted and is pending deletion has been deleted and is pending deletion - contoso-videoanalyzer" + } + } + }, + "500": { + "body": { + "error": { + "code": "GENERAL", + "message": "Trace id: '9677927b-ae6b-496g-1df8-9ec3048b4bf2'." + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViGenerateAccessToken/ViGenerateAccountContributerAccessToken.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViGenerateAccessToken/ViGenerateAccountContributerAccessToken.json new file mode 100644 index 000000000000..1159a1483451 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViGenerateAccessToken/ViGenerateAccountContributerAccessToken.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2021-10-27-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "permissionType": "Contributor", + "scope": "Account" + } + }, + "responses": { + "200": { + "body": { + "accessToken": "" + } + }, + "400": { + "body": { + "error": { + "code": "INVALID_INPUT", + "message": "Account '/subscriptions/b04775c3-63fa-40f3-9430-139d2e5522d3/resourceGroups/contosto-videoanalyzer-rg/providers/Microsoft.Contoso/accounts/contosto-videoanalyzer' not found." + } + } + }, + "404": { + "body": {} + }, + "409": { + "body": { + "error": { + "code": "ALREADY_EXISTS", + "message": "Account with '74f866ea-f74f-4103-a916-4742f8bc0009' already exists" + } + } + }, + "500": { + "body": { + "error": { + "code": "GENERAL", + "message": "Trace id: '9677927b-ae6b-496g-1df8-9ec3048b4bf2'." + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViGenerateAccessToken/ViGenerateAccountReaderAccessToken.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViGenerateAccessToken/ViGenerateAccountReaderAccessToken.json new file mode 100644 index 000000000000..3a39209aa9bb --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViGenerateAccessToken/ViGenerateAccountReaderAccessToken.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2021-10-27-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "permissionType": "Reader", + "scope": "Account" + } + }, + "responses": { + "200": { + "body": { + "accessToken": "" + } + }, + "400": { + "body": { + "error": { + "code": "INVALID_INPUT", + "message": "Account '/subscriptions/b04775c3-63fa-40f3-9430-139d2e5522d3/resourceGroups/contosto-videoanalyzer-rg/providers/Microsoft.Contoso/accounts/contosto-videoanalyzer' not found." + } + } + }, + "404": { + "body": {} + }, + "409": { + "body": { + "error": { + "code": "ALREADY_EXISTS", + "message": "Account with '74f866ea-f74f-4103-a916-4742f8bc0009' already exists" + } + } + }, + "500": { + "body": { + "error": { + "code": "GENERAL", + "message": "Trace id: '9677927b-ae6b-496g-1df8-9ec3048b4bf2'." + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViGenerateAccessToken/ViGenerateProjectContributerAccessToken1.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViGenerateAccessToken/ViGenerateProjectContributerAccessToken1.json new file mode 100644 index 000000000000..f2e47850e829 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViGenerateAccessToken/ViGenerateProjectContributerAccessToken1.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2021-10-27-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "permissionType": "Contributor", + "scope": "Project", + "projectId": "07ec9e38d4" + } + }, + "responses": { + "200": { + "body": { + "accessToken": "" + } + }, + "400": { + "body": { + "error": { + "code": "INVALID_INPUT", + "message": "Account '/subscriptions/b04775c3-63fa-40f3-9430-139d2e5522d3/resourceGroups/contosto-videoanalyzer-rg/providers/Microsoft.Contoso/accounts/contosto-videoanalyzer' not found." + } + } + }, + "404": { + "body": { + "error": { + "code": "BREAKDOWN_NOT_FOUND", + "message": "Video/Project '07ec9e38d4' was not found" + } + } + }, + "409": { + "body": { + "error": { + "code": "ALREADY_EXISTS", + "message": "Account with '74f866ea-f74f-4103-a916-4742f8bc0009' already exists" + } + } + }, + "500": { + "body": { + "error": { + "code": "GENERAL", + "message": "Trace id: '9677927b-ae6b-496g-1df8-9ec3048b4bf2'." + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViGenerateAccessToken/ViGenerateProjectContributerAccessToken2.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViGenerateAccessToken/ViGenerateProjectContributerAccessToken2.json new file mode 100644 index 000000000000..de36322e1841 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViGenerateAccessToken/ViGenerateProjectContributerAccessToken2.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2021-10-27-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "permissionType": "Contributor", + "scope": "Project", + "projectId": "07ec9e38d4" + } + }, + "responses": { + "200": { + "body": { + "accessToken": "" + } + }, + "400": { + "body": { + "error": { + "code": "INVALID_INPUT", + "message": "Account '/subscriptions/b04775c3-63fa-40f3-9430-139d2e5522d3/resourceGroups/contosto-videoanalyzer-rg/providers/Microsoft.Contoso/accounts/contosto-videoanalyzer' not found." + } + } + }, + "404": { + "body": { + "error": { + "code": "INVALID_INPUT", + "message": "Playlist '07ec9e38d4' does not belong to account '74h866ca-f74f-7963-a926-4712f5bc0123'. Trace id: '9677927b-ae6b-496g-1df8-9ec3048b4bf2'" + } + } + }, + "409": { + "body": { + "error": { + "code": "ALREADY_EXISTS", + "message": "Account with '74f866ea-f74f-4103-a916-4742f8bc0009' already exists" + } + } + }, + "500": { + "body": { + "error": { + "code": "GENERAL", + "message": "Trace id: '9677927b-ae6b-496g-1df8-9ec3048b4bf2'." + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViGenerateAccessToken/ViGenerateProjectReaderAccessToken1.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViGenerateAccessToken/ViGenerateProjectReaderAccessToken1.json new file mode 100644 index 000000000000..d4e8e943b509 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViGenerateAccessToken/ViGenerateProjectReaderAccessToken1.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2021-10-27-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "permissionType": "Reader", + "scope": "Project", + "projectId": "07ec9e38d4" + } + }, + "responses": { + "200": { + "body": { + "accessToken": "" + } + }, + "400": { + "body": { + "error": { + "code": "INVALID_INPUT", + "message": "Account '/subscriptions/b04775c3-63fa-40f3-9430-139d2e5522d3/resourceGroups/contosto-videoanalyzer-rg/providers/Microsoft.Contoso/accounts/contosto-videoanalyzer' not found." + } + } + }, + "404": { + "body": { + "error": { + "code": "BREAKDOWN_NOT_FOUND", + "message": "Video/Project '07ec9e38d4' was not found" + } + } + }, + "409": { + "body": { + "error": { + "code": "ALREADY_EXISTS", + "message": "Account with '74f866ea-f74f-4103-a916-4742f8bc0009' already exists" + } + } + }, + "500": { + "body": { + "error": { + "code": "GENERAL", + "message": "Trace id: '9677927b-ae6b-496g-1df8-9ec3048b4bf2'." + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViGenerateAccessToken/ViGenerateProjectReaderAccessToken2.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViGenerateAccessToken/ViGenerateProjectReaderAccessToken2.json new file mode 100644 index 000000000000..7f39e23c5b46 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViGenerateAccessToken/ViGenerateProjectReaderAccessToken2.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2021-10-27-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "permissionType": "Reader", + "scope": "Project", + "projectId": "07ec9e38d4" + } + }, + "responses": { + "200": { + "body": { + "accessToken": "" + } + }, + "400": { + "body": { + "error": { + "code": "INVALID_INPUT", + "message": "Account '/subscriptions/b04775c3-63fa-40f3-9430-139d2e5522d3/resourceGroups/contosto-videoanalyzer-rg/providers/Microsoft.Contoso/accounts/contosto-videoanalyzer' not found." + } + } + }, + "404": { + "body": { + "error": { + "code": "INVALID_INPUT", + "message": "Playlist '07ec9e38d4' does not belong to account '74h866ca-f74f-7963-a926-4712f5bc0123'. Trace id: '9677927b-ae6b-496g-1df8-9ec3048b4bf2'" + } + } + }, + "409": { + "body": { + "error": { + "code": "ALREADY_EXISTS", + "message": "Account with '74f866ea-f74f-4103-a916-4742f8bc0009' already exists" + } + } + }, + "500": { + "body": { + "error": { + "code": "GENERAL", + "message": "Trace id: '9677927b-ae6b-496g-1df8-9ec3048b4bf2'." + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViGenerateAccessToken/ViGenerateVideoContributerAccessToken1.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViGenerateAccessToken/ViGenerateVideoContributerAccessToken1.json new file mode 100644 index 000000000000..208e56f1ea8a --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViGenerateAccessToken/ViGenerateVideoContributerAccessToken1.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2021-10-27-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "permissionType": "Contributor", + "scope": "Video", + "videoId": "07ec9e38d4" + } + }, + "responses": { + "200": { + "body": { + "accessToken": "" + } + }, + "400": { + "body": { + "error": { + "code": "INVALID_INPUT", + "message": "Account '/subscriptions/b04775c3-63fa-40f3-9430-139d2e5522d3/resourceGroups/contosto-videoanalyzer-rg/providers/Microsoft.Contoso/accounts/contosto-videoanalyzer' not found." + } + } + }, + "404": { + "body": { + "error": { + "code": "BREAKDOWN_NOT_FOUND", + "message": "Video/Project '07ec9e38d4' was not found" + } + } + }, + "409": { + "body": { + "error": { + "code": "ALREADY_EXISTS", + "message": "Account with '74f866ea-f74f-4103-a916-4742f8bc0009' already exists" + } + } + }, + "500": { + "body": { + "error": { + "code": "GENERAL", + "message": "Trace id: '9677927b-ae6b-496g-1df8-9ec3048b4bf2'." + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViGenerateAccessToken/ViGenerateVideoContributerAccessToken2.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViGenerateAccessToken/ViGenerateVideoContributerAccessToken2.json new file mode 100644 index 000000000000..62fa56c06fa4 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViGenerateAccessToken/ViGenerateVideoContributerAccessToken2.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2021-10-27-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "permissionType": "Contributor", + "scope": "Video", + "videoId": "07ec9e38d4" + } + }, + "responses": { + "200": { + "body": { + "accessToken": "" + } + }, + "400": { + "body": { + "error": { + "code": "INVALID_INPUT", + "message": "Account '/subscriptions/b04775c3-63fa-40f3-9430-139d2e5522d3/resourceGroups/contosto-videoanalyzer-rg/providers/Microsoft.Contoso/accounts/contosto-videoanalyzer' not found." + } + } + }, + "404": { + "body": { + "error": { + "code": "INVALID_INPUT", + "message": "Playlist '07ec9e38d4' does not belong to account '74h866ca-f74f-7963-a926-4712f5bc0123'. Trace id: '9677927b-ae6b-496g-1df8-9ec3048b4bf2'" + } + } + }, + "409": { + "body": { + "error": { + "code": "ALREADY_EXISTS", + "message": "Account with '74f866ea-f74f-4103-a916-4742f8bc0009' already exists" + } + } + }, + "500": { + "body": { + "error": { + "code": "GENERAL", + "message": "Trace id: '9677927b-ae6b-496g-1df8-9ec3048b4bf2'." + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViGenerateAccessToken/ViGenerateVideoReaderAccessToken1.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViGenerateAccessToken/ViGenerateVideoReaderAccessToken1.json new file mode 100644 index 000000000000..868f2907422a --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViGenerateAccessToken/ViGenerateVideoReaderAccessToken1.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2021-10-27-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "permissionType": "Reader", + "scope": "Video", + "videoId": "07ec9e38d4" + } + }, + "responses": { + "200": { + "body": { + "accessToken": "" + } + }, + "400": { + "body": { + "error": { + "code": "INVALID_INPUT", + "message": "Account '/subscriptions/b04775c3-63fa-40f3-9430-139d2e5522d3/resourceGroups/contosto-videoanalyzer-rg/providers/Microsoft.Contoso/accounts/contosto-videoanalyzer' not found." + } + } + }, + "404": { + "body": { + "error": { + "code": "BREAKDOWN_NOT_FOUND", + "message": "Video/Project '07ec9e38d4' was not found" + } + } + }, + "409": { + "body": { + "error": { + "code": "ALREADY_EXISTS", + "message": "Account with '74f866ea-f74f-4103-a916-4742f8bc0009' already exists" + } + } + }, + "500": { + "body": { + "error": { + "code": "GENERAL", + "message": "Trace id: '9677927b-ae6b-496g-1df8-9ec3048b4bf2'." + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViGenerateAccessToken/ViGenerateVideoReaderAccessToken2.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViGenerateAccessToken/ViGenerateVideoReaderAccessToken2.json new file mode 100644 index 000000000000..a395526304fa --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViGenerateAccessToken/ViGenerateVideoReaderAccessToken2.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2021-10-27-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "permissionType": "Reader", + "scope": "Video", + "videoId": "07ec9e38d4" + } + }, + "responses": { + "200": { + "body": { + "accessToken": "" + } + }, + "400": { + "body": { + "error": { + "code": "INVALID_INPUT", + "message": "Account '/subscriptions/b04775c3-63fa-40f3-9430-139d2e5522d3/resourceGroups/contosto-videoanalyzer-rg/providers/Microsoft.Contoso/accounts/contosto-videoanalyzer' not found." + } + } + }, + "404": { + "body": { + "error": { + "code": "INVALID_INPUT", + "message": "Playlist '07ec9e38d4' does not belong to account '74h866ca-f74f-7963-a926-4712f5bc0123'. Trace id: '9677927b-ae6b-496g-1df8-9ec3048b4bf2'" + } + } + }, + "409": { + "body": { + "error": { + "code": "ALREADY_EXISTS", + "message": "Account with '74f866ea-f74f-4103-a916-4742f8bc0009' already exists" + } + } + }, + "500": { + "body": { + "error": { + "code": "GENERAL", + "message": "Trace id: '9677927b-ae6b-496g-1df8-9ec3048b4bf2'." + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViListUserClassicAccounts.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViListUserClassicAccounts.json new file mode 100644 index 000000000000..29800e724d69 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViListUserClassicAccounts.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2021-10-27-preview", + "location": "NorthEurope" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "contoso-videoanalyzer", + "location": "NorthEurope" + } + ], + "nextLink": "link" + } + }, + "500": { + "body": { + "error": { + "code": "GENERAL", + "message": "Trace id: '9677927b-ae6b-496g-1df8-9ec3048b4bf2'." + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViOperationsList.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViOperationsList.json new file mode 100644 index 000000000000..ddc52a105fef --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/examples/ViOperationsList.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2021-10-27-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.VideoIndexer/accounts/read", + "display": { + "provider": "Microsoft Azure Video Analyzer for Media", + "resource": "Account", + "operation": "Read accounts", + "description": "Read accounts" + } + }, + { + "name": "Microsoft.VideoIndexer/accounts/write", + "display": { + "provider": "Microsoft Azure Video Analyzer for Media", + "resource": "Account", + "operation": "Update accounts", + "description": "Update accounts" + } + }, + { + "name": "Microsoft.VideoIndexer/accounts/delete", + "display": { + "provider": "Microsoft Azure Video Analyzer for Media", + "resource": "Account", + "operation": "Delete accounts", + "description": "Delete accounts" + } + } + ] + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/vi.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/vi.json new file mode 100644 index 000000000000..d4c087c91d33 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2021-10-27-preview/vi.json @@ -0,0 +1,1250 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-10-27-preview", + "title": "vi", + "description": "Microsoft Azure Video Analyzer for Media" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.VideoIndexer/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available Azure Video Analyzer for Media provider operations.", + "operationId": "Operations_List", + "x-ms-examples": { + "List operations": { + "$ref": "./examples/ViOperationsList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.VideoIndexer/checkNameAvailability": { + "post": { + "tags": [ + "NameAvailability" + ], + "operationId": "Accounts_CheckNameAvailability", + "description": "Checks that the Video Indexer account name is valid and is not already in use.", + "x-ms-examples": { + "Check free account name availability": { + "$ref": "./examples/ViAccountCheckNameAvailabilityFree.json" + }, + "Check taken account name availability": { + "$ref": "./examples/ViAccountCheckNameAvailabilityTaken.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "checkNameAvailabilityParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AccountCheckNameAvailabilityParameters" + }, + "description": "The name of the Video Indexer account. Name must be unique globally" + } + ], + "responses": { + "200": { + "description": "OK - Operation to check the Video Indexer account name availability was successful. Ok does not indicate the name is available, the body of the response does.", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.VideoIndexer/accounts": { + "get": { + "tags": [ + "Accounts" + ], + "operationId": "Accounts_List", + "description": "List all Azure Video Analyzer for Media accounts available under the subscription", + "x-ms-examples": { + "List accounts": { + "$ref": "./examples/ViAccountsList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AccountList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VideoIndexer/accounts": { + "get": { + "tags": [ + "Accounts" + ], + "operationId": "Accounts_ListByResourceGroup", + "description": "List all Azure Video Analyzer for Media accounts available under the resource group", + "x-ms-examples": { + "List accounts by resource group": { + "$ref": "./examples/ViAccountsListByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AccountList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VideoIndexer/accounts/{accountName}": { + "get": { + "tags": [ + "Accounts" + ], + "operationId": "Accounts_Get", + "description": "Gets the properties of an Azure Video Analyzer for Media account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Azure Video Analyzer for Media account properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get account": { + "$ref": "./examples/ViAccountGet.json" + } + } + }, + "patch": { + "tags": [ + "Accounts" + ], + "operationId": "Accounts_Update", + "x-ms-long-running-operation": false, + "description": "Updates the properties of an existing Azure Video Analyzer for Media account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "The parameters to provide for the current Azure Video Analyzer for Media account.", + "schema": { + "$ref": "#/definitions/AccountPatch" + } + } + ], + "responses": { + "200": { + "description": "The resource was updated successfully.", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "400": { + "description": "Bad Request.", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "404": { + "description": "Not Found", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "500": { + "description": "Internal Server Error", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch example #1": { + "$ref": "./examples/ViAccountPatch/ViAccountPatch1.json" + }, + "Patch example #2": { + "$ref": "./examples/ViAccountPatch/ViAccountPatch2.json" + }, + "Patch example #3": { + "$ref": "./examples/ViAccountPatch/ViAccountPatch3.json" + }, + "Patch example #4": { + "$ref": "./examples/ViAccountPatch/ViAccountPatch4.json" + }, + "Patch example #5": { + "$ref": "./examples/ViAccountPatch/ViAccountPatch5.json" + }, + "Patch example #6": { + "$ref": "./examples/ViAccountPatch/ViAccountPatch6.json" + }, + "Patch example #7": { + "$ref": "./examples/ViAccountPatch/ViAccountPatch7.json" + }, + "Patch example #8": { + "$ref": "./examples/ViAccountPatch/ViAccountPatch8.json" + } + } + }, + "put": { + "tags": [ + "Accounts" + ], + "operationId": "Accounts_CreateOrUpdate", + "description": "Creates or updates an Azure Video Analyzer for Media account.", + "x-ms-long-running-operation": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "The parameters to provide for the Azure Video Analyzer for Media account.", + "schema": { + "$ref": "#/definitions/Account" + } + } + ], + "responses": { + "200": { + "description": "The resource was successfully updated.", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "400": { + "description": "Bad Request.", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "404": { + "description": "Not Found", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "409": { + "description": "Conflict", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "500": { + "description": "Internal Server Error", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Put example #1": { + "$ref": "./examples/ViAccountPut/ViAccountPut1.json" + }, + "Put example #2": { + "$ref": "./examples/ViAccountPut/ViAccountPut2.json" + }, + "Put example #3": { + "$ref": "./examples/ViAccountPut/ViAccountPut3.json" + }, + "Put example #4": { + "$ref": "./examples/ViAccountPut/ViAccountPut4.json" + }, + "Put example #5": { + "$ref": "./examples/ViAccountPut/ViAccountPut5.json" + }, + "Put example #6": { + "$ref": "./examples/ViAccountPut/ViAccountPut6.json" + }, + "Put example #7": { + "$ref": "./examples/ViAccountPut/ViAccountPut7.json" + }, + "Put example #8": { + "$ref": "./examples/ViAccountPut/ViAccountPut8.json" + }, + "Put example #9": { + "$ref": "./examples/ViAccountPut/ViAccountPut9.json" + }, + "Put example #10": { + "$ref": "./examples/ViAccountPut/ViAccountPut10.json" + } + } + }, + "delete": { + "tags": [ + "Accounts" + ], + "operationId": "Accounts_Delete", + "description": "Delete an Azure Video Analyzer for Media account.", + "x-ms-long-running-operation": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Azure Video Analyzer for Media account was successfully deleted." + }, + "202": { + "description": "The Azure Video Analyzer for Media account will be deleted asynchronously." + }, + "204": { + "description": "The Azure Video Analyzer for Media account does not exist." + }, + "500": { + "description": "Internal Server Error", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete account": { + "$ref": "./examples/ViAccountDelete.json" + } + } + } + }, + "/providers/Microsoft.VideoIndexer/locations/{location}/userClassicAccounts": { + "get": { + "tags": [ + "Accounts" + ], + "operationId": "UserClassicAccounts_List", + "description": "Lists all Azure Video Analyzer for Media classic accounts", + "x-ms-examples": { + "List accounts": { + "$ref": "./examples/ViListUserClassicAccounts.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UserClassicAccountList" + } + }, + "500": { + "description": "Internal Server Error", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.VideoIndexer/locations/{location}/classicAccounts/{accountName}": { + "get": { + "tags": [ + "Accounts" + ], + "operationId": "ClassicAccounts_GetDetails", + "description": "Gets the properties of an Azure Video Analyzer for Media Classic account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + } + ], + "responses": { + "200": { + "description": "The Azure Video Analyzer for Media account properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/ClassicAccount" + } + }, + "400": { + "description": "Bad Request.", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "401": { + "description": "User Not Allowed", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "404": { + "description": "Not Found", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "500": { + "description": "Internal Server Error", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get account": { + "$ref": "./examples/ViClassicAccounts.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VideoIndexer/accounts/{accountName}/generateAccessToken": { + "post": { + "tags": [ + "AccessToken" + ], + "operationId": "Generate_AccessToken", + "description": "Generate an Azure Video Analyzer for Media access token.", + "x-ms-examples": { + "Generate accessToken for video contributor #1": { + "$ref": "./examples/ViGenerateAccessToken/ViGenerateVideoContributerAccessToken1.json" + }, + "Generate accessToken for video contributor #2": { + "$ref": "./examples/ViGenerateAccessToken/ViGenerateVideoContributerAccessToken2.json" + }, + "Generate accessToken for video reader #1": { + "$ref": "./examples/ViGenerateAccessToken/ViGenerateVideoReaderAccessToken1.json" + }, + "Generate accessToken for video reader #2": { + "$ref": "./examples/ViGenerateAccessToken/ViGenerateVideoReaderAccessToken2.json" + }, + "Generate accessToken for project contributor #1": { + "$ref": "./examples/ViGenerateAccessToken/ViGenerateProjectContributerAccessToken1.json" + }, + "Generate accessToken for project contributor #2": { + "$ref": "./examples/ViGenerateAccessToken/ViGenerateProjectContributerAccessToken2.json" + }, + "Generate accessToken for project reader #1": { + "$ref": "./examples/ViGenerateAccessToken/ViGenerateProjectReaderAccessToken1.json" + }, + "Generate accessToken for project reader #2": { + "$ref": "./examples/ViGenerateAccessToken/ViGenerateProjectReaderAccessToken2.json" + }, + "Generate accessToken for account contributor": { + "$ref": "./examples/ViGenerateAccessToken/ViGenerateAccountContributerAccessToken.json" + }, + "Generate accessToken for account reader": { + "$ref": "./examples/ViGenerateAccessToken/ViGenerateAccountReaderAccessToken.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "x-ms-client-flatten": true, + "description": "The parameters for generating access token", + "schema": { + "$ref": "#/definitions/GenerateAccessTokenParameters" + } + } + ], + "responses": { + "200": { + "description": "The Azure Video Analyzer for Media account's access token properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/AccessToken" + } + }, + "400": { + "description": "Bad Request.", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "404": { + "description": "Not Found", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "409": { + "description": "Conflict", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "500": { + "description": "Internal Server Error", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "Tags": { + "type": "object", + "description": "Resource tags", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags" + } + } + }, + "Account": { + "description": "An Azure Video Analyzer for Media account.", + "type": "object", + "properties": { + "properties": { + "description": "List of account properties", + "type": "object", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AccountPropertiesForPutRequest" + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" + } + ] + }, + "AccountPatch": { + "type": "object", + "description": "Azure Video Analyzer for Media account", + "properties": { + "properties": { + "description": "List of account properties", + "type": "object", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AccountPropertiesForPatchRequest" + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Tags" + } + ] + }, + "AccountPropertiesForPutRequest": { + "description": "Azure Video Analyzer for Media account properties", + "type": "object", + "properties": { + "tenantId": { + "description": "The account's tenant id", + "type": "string", + "readOnly": true, + "example": "2b9bcf6d-39d5-460a-a6bb-7b40b7ccf139" + }, + "accountId": { + "description": "The account's data-plane ID", + "type": "string", + "example": "3575690b-a569-449c-ab7b-11020f948f76" + }, + "accountName": { + "description": "The account's name", + "type": "string", + "readOnly": true, + "example": "contoso-videoAnalyzer" + }, + "mediaServices": { + "description": "The media services details", + "type": "object", + "$ref": "#/definitions/MediaServicesForPutRequest" + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Gets the status of the account at the time the operation was called.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Accepted", + "Provisioning", + "Deleting" + ], + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true + } + } + } + }, + "AccountPropertiesForPatchRequest": { + "description": "Azure Video Analyzer for Media account properties", + "type": "object", + "properties": { + "tenantId": { + "description": "The account's tenant id", + "type": "string", + "readOnly": true, + "example": "2b9bcf6d-39d5-460a-a6bb-7b40b7ccf139" + }, + "accountId": { + "description": "The account's data-plane ID", + "readOnly": true, + "type": "string", + "example": "3575690b-a569-449c-ab7b-11020f948f76" + }, + "mediaServices": { + "description": "The media services details", + "type": "object", + "$ref": "#/definitions/MediaServicesForPatchRequest" + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Gets the status of the account at the time the operation was called.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Accepted", + "Provisioning", + "Deleting" + ], + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true + } + } + } + }, + "AccountList": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Account" + }, + "description": "List of accounts and their properties." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any.", + "example": "https://management.azure.com/{accountsOperation}?api-version={version}&%24skiptoken={token}" + } + }, + "description": "The list operation response, that contains the data pools and their properties.", + "type": "object" + }, + "GenerateAccessTokenParameters": { + "description": "Access token generation request's parameters", + "type": "object", + "required": [ + "permissionType", + "scope" + ], + "properties": { + "permissionType": { + "type": "string", + "description": "The requested permission", + "enum": [ + "Contributor", + "Reader" + ], + "x-ms-enum": { + "name": "permissionType", + "modelAsString": true + } + }, + "scope": { + "type": "string", + "description": "The requested media type", + "enum": [ + "Video", + "Account", + "Project" + ], + "x-ms-enum": { + "name": "scope", + "modelAsString": true + } + }, + "videoId": { + "description": "The video ID", + "type": "string", + "example": "07ec9e38d4" + }, + "projectId": { + "description": "The project ID", + "type": "string" + } + } + }, + "MediaServicesForPutRequest": { + "description": "The media services details", + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "description": "The media services resource id", + "example": "/subscriptions/xxx/resourceGroups/contoso-videoAnalyzer-rg/providers/Microsoft.Media/mediaservices/contoso-videoAnalyzer-ms" + }, + "userAssignedIdentity": { + "type": "string", + "description": "The user assigned identity to be used to grant permissions", + "example": "/subscriptions/xxx/resourceGroups/contoso-videoAnalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoAnalyzer-mi" + } + } + }, + "MediaServicesForPatchRequest": { + "description": "The media services details", + "type": "object", + "properties": { + "userAssignedIdentity": { + "type": "string", + "description": "The user assigned identity to be used to grant permissions", + "example": "/subscriptions/xxx/resourceGroups/contoso-videoAnalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoAnalyzer-mi" + } + } + }, + "AccessToken": { + "description": "Azure Video Analyzer for Media access token.", + "type": "object", + "properties": { + "accessToken": { + "type": "string", + "readOnly": true, + "description": "The access token.", + "x-ms-secret": true, + "example": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJPbmxpbmUgSldUIEJ1aWxkZXIiLCJpYXQiOjE2MjI0NDc3MzMsImV4cCI6MTY1Mzk4MzczMywiYXVkIjoid3d3LmV4YW1wbGUuY29tIiwic3ViIjoianJvY2tldEBleGFtcGxlLmNvbSIsIkdpdmVuTmFtZSI6IkpvaG5ueSIsIlN1cm5hbWUiOiJSb2NrZXQiLCJFbWFpbCI6Impyb2NrZXRAZXhhbXBsZS5jb20iLCJSb2xlIjpbIk1hbmFnZXIiLCJQcm9qZWN0IEFkbWluaXN0cmF0b3IiXX0" + } + } + }, + "UserClassicAccountList": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ClassicAccountSlim" + }, + "description": "List of classic account names and their location." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any.", + "example": "https://management.azure.com/{accountsOperation}?api-version={version}&%24skiptoken={token}" + } + }, + "description": "The list of user classic accounts.", + "type": "object" + }, + "ClassicAccountSlim": { + "description": "An Azure Video Analyzer for Media classic account.", + "type": "object", + "properties": { + "name": { + "description": "The account's name", + "type": "string", + "readOnly": true, + "example": "contoso-videoanalyzer" + }, + "location": { + "description": "The account's location", + "type": "string", + "readOnly": true, + "example": "westus" + } + } + }, + "ClassicAccount": { + "description": "An Azure Video Analyzer for Media classic account.", + "type": "object", + "properties": { + "name": { + "description": "The account's name", + "type": "string", + "readOnly": true, + "example": "contoso-videoanalyzer" + }, + "location": { + "description": "The account's location", + "type": "string", + "example": "westus" + }, + "mediaServices": { + "description": "List of classic account properties", + "type": "object", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ClassicAccountMediaServices" + } + } + }, + "ClassicAccountMediaServices": { + "description": "Azure Video Analyzer for Media classic account properties", + "type": "object", + "properties": { + "aadApplicationId": { + "type": "string", + "description": "The aad application id", + "example": "912f96dc-1ed3-4d7d-aa67-0adef4bb68ad" + }, + "aadTenantId": { + "type": "string", + "description": "The aad tenant id", + "example": "72f988bf-86f1-41ag-91ab-2d7cd061db47" + }, + "connected": { + "type": "boolean", + "description": "Represents wether the media services is connected or not" + }, + "eventGridProviderRegistered": { + "type": "boolean", + "description": "Represents if the media services event grid is connected or not" + }, + "name": { + "type": "string", + "description": "The media services name", + "example": "contosoVideoanalyzerMediaServices" + }, + "resourceGroup": { + "type": "string", + "description": "The resource group that the media services belong to", + "example": "contoso-videoanalyzer-rg" + }, + "streamingEndpointStarted": { + "type": "boolean", + "description": "Represents wether the media services streaming endpoint has started" + }, + "subscriptionId": { + "type": "string", + "description": "The media services subscriptionId", + "example": "586d4f48-8f08-4a4e-96b7-e1892d6dba9e" + } + } + }, + "Operation": { + "description": "Operation detail payload", + "type": "object", + "properties": { + "name": { + "description": "Name of the operation", + "readOnly": true, + "type": "string", + "example": "Microsoft.VideoIndexer/accounts/read" + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "readOnly": true, + "type": "boolean", + "example": false + }, + "actionType": { + "description": "Indicates the action type.", + "readOnly": true, + "type": "string", + "example": "Internal" + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "readOnly": true, + "description": "Display of the operation" + }, + "origin": { + "description": "Origin of the operation", + "readOnly": true, + "type": "string", + "example": "user" + } + } + }, + "OperationDisplay": { + "description": "Operation display payload", + "type": "object", + "properties": { + "provider": { + "description": "Resource provider of the operation", + "readOnly": true, + "type": "string", + "example": "Microsoft Azure Video Analyzer for Media" + }, + "resource": { + "description": "Resource of the operation", + "readOnly": true, + "type": "string", + "example": "accounts" + }, + "operation": { + "description": "Localized friendly name for the operation", + "readOnly": true, + "type": "string", + "example": "Read accounts" + }, + "description": { + "description": "Localized friendly description for the operation", + "readOnly": true, + "type": "string", + "example": "Read accounts details" + } + } + }, + "OperationListResult": { + "description": "Available operations of the service.", + "type": "object", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Operation" + }, + "description": "List of operations supported by the Resource Provider." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "URL to get the next set of operation list results if there are any.", + "example": "https://management.azure.com/{operation}?api-version={version}&%24skiptoken={token}" + } + } + }, + "ErrorResponse": { + "description": "Error response.", + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/ErrorDefinition", + "description": "The error details." + } + } + }, + "ErrorDefinition": { + "description": "Error definition.", + "type": "object", + "properties": { + "code": { + "description": "Service specific error code which serves as the substatus for the HTTP error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Description of the error.", + "type": "string", + "readOnly": true + }, + "details": { + "description": "Internal error details.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorDefinition" + }, + "readOnly": true + } + } + }, + "AccountCheckNameAvailabilityParameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The VideoIndexer account name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.VideoIndexer/accounts" + ], + "x-ms-enum": { + "name": "Type", + "modelAsString": true + }, + "description": "The type of resource, Microsoft.VideoIndexer/accounts" + } + }, + "required": [ + "name", + "type" + ], + "description": "The parameters used to check the availability of the Video Indexer account name." + }, + "CheckNameAvailabilityResult": { + "type": "object", + "properties": { + "nameAvailable": { + "readOnly": true, + "type": "boolean", + "description": "Gets a boolean value that indicates whether the name is available for you to use. If true, the name is available. If false, the name has already been taken." + }, + "reason": { + "readOnly": true, + "type": "string", + "description": "Gets the reason that a Video Indexer account name could not be used. The Reason element is only returned if NameAvailable is false.", + "enum": [ + "AlreadyExists" + ], + "x-ms-enum": { + "name": "Reason", + "modelAsString": true + } + }, + "message": { + "readOnly": true, + "type": "string", + "description": "Gets an error message explaining the Reason value in more detail." + } + }, + "description": "The CheckNameAvailability operation response." + } + }, + "parameters": { + "AccountNameParameter": { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure Video Analyzer for Media account.", + "pattern": "^[a-z0-9]+(-[a-z0-9]+)*", + "maxLength": 50, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/vi/resource-manager/readme.design.md b/specification/vi/resource-manager/readme.design.md index 915e576ab0a7..7020a9929902 100644 --- a/specification/vi/resource-manager/readme.design.md +++ b/specification/vi/resource-manager/readme.design.md @@ -36,4 +36,4 @@ Users will be able to easily create, manage and delete a Azure Video Analyzer fo ## Type Model Resource provider namespace: Microsoft.VideoIndexer -Resource type: accounts. type model is still under develop.. The resource type properties can be found [here](./Microsoft.VideoIndexer/preview/2021-10-18-preview/vi.json#L413) \ No newline at end of file +Resource type: accounts. type model is still under develop.. The resource type properties can be found [here](./Microsoft.VideoIndexer/preview/2021-10-27-preview/vi.json#L413) \ No newline at end of file diff --git a/specification/vi/resource-manager/readme.go.md b/specification/vi/resource-manager/readme.go.md index f4793723bc5b..facc8fff1b20 100644 --- a/specification/vi/resource-manager/readme.go.md +++ b/specification/vi/resource-manager/readme.go.md @@ -13,6 +13,7 @@ go: ``` yaml $(go) && $(multiapi) batch: - tag: package-2021-10-18-preview + - tag: package-2021-10-27-preview ``` please also specify `--go-sdks-folder=`. diff --git a/specification/vi/resource-manager/readme.md b/specification/vi/resource-manager/readme.md index b45f2ecb3e7a..71048cc1f022 100644 --- a/specification/vi/resource-manager/readme.md +++ b/specification/vi/resource-manager/readme.md @@ -24,6 +24,7 @@ directive: - suppress: SECRET_PROPERTY from: - Microsoft.VideoIndexer/preview/2021-10-18-preview/vi.json + - Microsoft.VideoIndexer/preview/2021-10-27-preview/vi.json where: - $.definitions.AccessToken.properties.accessToken @@ -41,7 +42,20 @@ These are the global settings for the adp. title: ViManagementClient openapi-type: arm openapi-subtype: rpaas -tag: package-2021-10-18-preview +tag: package-2021-10-27-preview +``` + +### Tag: package-2021-10-27-preview + +These settings apply only when `--tag=2021-10-27-preview` is specified on the command line. + +```yaml $(tag) == 'package-2021-10-27-preview' +version: 2021-10-27-preview +version-with-underscores: 2021_10_27_preview +input-file: + - Microsoft.VideoIndexer/preview/2021-10-27-preview/vi.json +modelerfour: + lenient-model-deduplication: true ``` ### Tag: package-2021-10-18-preview @@ -98,4 +112,4 @@ See configuration in [readme.csharp.md](./readme.csharp.md) ## Node.js -See configuration in [readme.nodejs.md](./readme.nodejs.md) \ No newline at end of file +See configuration in [readme.nodejs.md](./readme.nodejs.md) diff --git a/specification/vi/resource-manager/readme.terraform.md b/specification/vi/resource-manager/readme.terraform.md index 4c0510593caf..1cd7023a6e3e 100644 --- a/specification/vi/resource-manager/readme.terraform.md +++ b/specification/vi/resource-manager/readme.terraform.md @@ -13,4 +13,8 @@ output-folder: $(terraform-output-folder)/vi ``` yaml $(tag) == 'package-2021-10-18-preview' && $(terraform) gosdk-folder: services/preview/vi/mgmt/2021-10-18-preview/vi +``` + +``` yaml $(tag) == 'package-2021-10-27-preview' && $(terraform) +gosdk-folder: services/preview/vi/mgmt/2021-10-27-preview/vi ``` \ No newline at end of file From 69eacf00a36d565d3220d5dd6f4a5293664f1ae9 Mon Sep 17 00:00:00 2001 From: Alfredo Santamaria Date: Thu, 28 Oct 2021 20:42:59 -0700 Subject: [PATCH 15/19] Service Fabric managed clusters api version 2021-11-01-preview (#16424) * initial comming copy from 2021-09-01-privatepreview * update swagger to version 2021-11-01-preview * update examples * adding serviceEndpoints * fix node type update tags * run prettier * remove api version enum as recommended not to get flagged on cros version breaking changes Co-authored-by: Alfredo Santamaria Gomez --- .../ApplicationDeleteOperation_example.json | 19 + .../ApplicationGetOperation_example.json | 59 + .../ApplicationListOperation_example.json | 27 + .../ApplicationPatchOperation_example.json | 66 + .../ApplicationPutOperation_example_max.json | 156 + .../ApplicationPutOperation_example_min.json | 79 + ...cationTypeNameDeleteOperation_example.json | 19 + ...plicationTypeNameGetOperation_example.json | 22 + ...licationTypeNameListOperation_example.json | 26 + ...icationTypeNamePatchOperation_example.json | 30 + ...plicationTypeNamePutOperation_example.json | 25 + ...ionTypeVersionDeleteOperation_example.json | 20 + ...cationTypeVersionGetOperation_example.json | 24 + ...ationTypeVersionListOperation_example.json | 28 + ...tionTypeVersionPatchOperation_example.json | 32 + ...cationTypeVersionPutOperation_example.json | 45 + .../examples/DeleteNodes_example.json | 24 + ...ManagedClusterDeleteOperation_example.json | 17 + .../ManagedClusterGetOperation_example.json | 71 + ...rListByResourceGroupOperation_example.json | 89 + ...erListBySubscriptionOperation_example.json | 88 + .../ManagedClusterPatchOperation_example.json | 106 + ...anagedClusterPutOperation_example_max.json | 384 +++ ...anagedClusterPutOperation_example_min.json | 119 + ...lusterVersionGetByEnvironment_example.json | 24 + .../ManagedClusterVersionGet_example.json | 23 + ...anagedClusterVersionListByEnvironment.json | 35 + .../ManagedClusterVersionList_example.json | 34 + .../NodeTypeDeleteOperation_example.json | 18 + .../NodeTypeGetOperation_example.json | 47 + .../NodeTypeListOperation_example.json | 93 + ...deTypePatchOperationAutoScale_example.json | 87 + .../NodeTypePatchOperation_example.json | 77 + ...NodeTypePutOperationAutoScale_example.json | 201 ++ .../NodeTypePutOperation_example_max.json | 261 ++ .../NodeTypePutOperation_example_min.json | 77 + .../NodeTypeSkusListOperation_example.json | 71 + .../examples/Operations_example.json | 95 + .../examples/ReimageNodes_example.json | 24 + .../examples/RestartNodes_example.json | 24 + .../ServiceDeleteOperation_example.json | 20 + .../examples/ServiceGetOperation_example.json | 39 + .../ServiceListOperation_example.json | 40 + .../ServicePatchOperation_example.json | 77 + .../ServicePutOperation_example_max.json | 189 ++ .../ServicePutOperation_example_min.json | 60 + .../managedUnsupportedVMSizesGet_example.json | 20 + ...managedUnsupportedVMSizesList_example.json | 175 ++ .../managedapplication.json | 2726 +++++++++++++++++ .../2021-11-01-preview/managedcluster.json | 1713 +++++++++++ .../preview/2021-11-01-preview/nodetype.json | 1469 +++++++++ .../resource-manager/readme.md | 13 +- 52 files changed, 9306 insertions(+), 1 deletion(-) create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationDeleteOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationGetOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationListOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationPatchOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationPutOperation_example_max.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationPutOperation_example_min.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationTypeNameDeleteOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationTypeNameGetOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationTypeNameListOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationTypeNamePatchOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationTypeNamePutOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationTypeVersionDeleteOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationTypeVersionGetOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationTypeVersionListOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationTypeVersionPatchOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationTypeVersionPutOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/DeleteNodes_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ManagedClusterDeleteOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ManagedClusterGetOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ManagedClusterListByResourceGroupOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ManagedClusterListBySubscriptionOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ManagedClusterPatchOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ManagedClusterPutOperation_example_max.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ManagedClusterPutOperation_example_min.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ManagedClusterVersionGetByEnvironment_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ManagedClusterVersionGet_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ManagedClusterVersionListByEnvironment.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ManagedClusterVersionList_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/NodeTypeDeleteOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/NodeTypeGetOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/NodeTypeListOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/NodeTypePatchOperationAutoScale_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/NodeTypePatchOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/NodeTypePutOperationAutoScale_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/NodeTypePutOperation_example_max.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/NodeTypePutOperation_example_min.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/NodeTypeSkusListOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/Operations_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ReimageNodes_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/RestartNodes_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ServiceDeleteOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ServiceGetOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ServiceListOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ServicePatchOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ServicePutOperation_example_max.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ServicePutOperation_example_min.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/managedUnsupportedVMSizesGet_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/managedUnsupportedVMSizesList_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/managedapplication.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/managedcluster.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/nodetype.json diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationDeleteOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationDeleteOperation_example.json new file mode 100644 index 000000000000..05045c69bc43 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationDeleteOperation_example.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "api-version": "2021-11-01-preview" + }, + "responses": { + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/76053752-a423-4a80-b283-1dad1ba5f314?api-version=2021-11-01-preview" + } + }, + "204": {}, + "200": {} + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationGetOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationGetOperation_example.json new file mode 100644 index 000000000000..a1f0ff9c6830 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationGetOperation_example.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "api-version": "2021-11-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp", + "name": "myApp", + "tags": {}, + "properties": { + "provisioningState": "Updating", + "version": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0", + "parameters": { + "param1": "value1" + }, + "upgradePolicy": { + "applicationHealthPolicy": { + "considerWarningAsError": true, + "maxPercentUnhealthyDeployedApplications": 0, + "defaultServiceTypeHealthPolicy": { + "maxPercentUnhealthyServices": 0, + "maxPercentUnhealthyPartitionsPerService": 0, + "maxPercentUnhealthyReplicasPerPartition": 0 + }, + "serviceTypeHealthPolicyMap": { + "service1": { + "maxPercentUnhealthyReplicasPerPartition": 30, + "maxPercentUnhealthyPartitionsPerService": 30, + "maxPercentUnhealthyServices": 30 + } + } + }, + "rollingUpgradeMonitoringPolicy": { + "failureAction": "Rollback", + "healthCheckRetryTimeout": "00:10:00", + "healthCheckWaitDuration": "00:02:00", + "healthCheckStableDuration": "00:05:00", + "upgradeDomainTimeout": "00:15:00", + "upgradeTimeout": "01:00:00" + }, + "upgradeReplicaSetCheckTimeout": 3600, + "forceRestart": false, + "instanceCloseDelayDuration": 600, + "upgradeMode": "UnmonitoredAuto", + "recreateApplication": false + } + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationListOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationListOperation_example.json new file mode 100644 index 000000000000..bd6e8e34b8f1 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationListOperation_example.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2021-11-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabric/managedClusters/applications", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp", + "name": "myApp", + "properties": { + "provisioningState": "Updating", + "version": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0" + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationPatchOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationPatchOperation_example.json new file mode 100644 index 000000000000..2edc2508297e --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationPatchOperation_example.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "api-version": "2021-11-01-preview", + "parameters": { + "tags": { + "a": "b" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp", + "name": "myApp", + "tags": { + "a": "b" + }, + "properties": { + "provisioningState": "Succeeded", + "version": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0", + "parameters": { + "param1": "value1" + }, + "upgradePolicy": { + "applicationHealthPolicy": { + "considerWarningAsError": true, + "maxPercentUnhealthyDeployedApplications": 0, + "defaultServiceTypeHealthPolicy": { + "maxPercentUnhealthyServices": 0, + "maxPercentUnhealthyPartitionsPerService": 0, + "maxPercentUnhealthyReplicasPerPartition": 0 + }, + "serviceTypeHealthPolicyMap": { + "service1": { + "maxPercentUnhealthyReplicasPerPartition": 30, + "maxPercentUnhealthyPartitionsPerService": 30, + "maxPercentUnhealthyServices": 30 + } + } + }, + "rollingUpgradeMonitoringPolicy": { + "failureAction": "Rollback", + "healthCheckRetryTimeout": "00:10:00", + "healthCheckWaitDuration": "00:02:00", + "healthCheckStableDuration": "00:05:00", + "upgradeDomainTimeout": "00:15:00", + "upgradeTimeout": "01:00:00" + }, + "upgradeReplicaSetCheckTimeout": 3600, + "forceRestart": false, + "instanceCloseDelayDuration": 600, + "upgradeMode": "UnmonitoredAuto", + "recreateApplication": false + } + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationPutOperation_example_max.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationPutOperation_example_max.json new file mode 100644 index 000000000000..3e2a3953ef88 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationPutOperation_example_max.json @@ -0,0 +1,156 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "api-version": "2021-11-01-preview", + "parameters": { + "location": "eastus", + "tags": { + "a": "b" + }, + "properties": { + "version": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0", + "parameters": { + "param1": "value1" + }, + "upgradePolicy": { + "applicationHealthPolicy": { + "considerWarningAsError": true, + "maxPercentUnhealthyDeployedApplications": 0, + "defaultServiceTypeHealthPolicy": { + "maxPercentUnhealthyServices": 0, + "maxPercentUnhealthyPartitionsPerService": 0, + "maxPercentUnhealthyReplicasPerPartition": 0 + }, + "serviceTypeHealthPolicyMap": { + "myService": { + "maxPercentUnhealthyReplicasPerPartition": 30, + "maxPercentUnhealthyPartitionsPerService": 30, + "maxPercentUnhealthyServices": 30 + } + } + }, + "rollingUpgradeMonitoringPolicy": { + "failureAction": "Rollback", + "healthCheckRetryTimeout": "00:10:00", + "healthCheckWaitDuration": "00:02:00", + "healthCheckStableDuration": "00:05:00", + "upgradeDomainTimeout": "00:15:00", + "upgradeTimeout": "01:00:00" + }, + "upgradeReplicaSetCheckTimeout": 3600, + "forceRestart": false, + "instanceCloseDelayDuration": 600, + "upgradeMode": "UnmonitoredAuto", + "recreateApplication": false + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp", + "name": "myApp", + "tags": { + "a": "b" + }, + "properties": { + "provisioningState": "Creating", + "version": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0", + "parameters": { + "param1": "value1" + }, + "upgradePolicy": { + "applicationHealthPolicy": { + "considerWarningAsError": true, + "maxPercentUnhealthyDeployedApplications": 0, + "defaultServiceTypeHealthPolicy": { + "maxPercentUnhealthyServices": 0, + "maxPercentUnhealthyPartitionsPerService": 0, + "maxPercentUnhealthyReplicasPerPartition": 0 + }, + "serviceTypeHealthPolicyMap": { + "service1": { + "maxPercentUnhealthyReplicasPerPartition": 30, + "maxPercentUnhealthyPartitionsPerService": 30, + "maxPercentUnhealthyServices": 30 + } + } + }, + "rollingUpgradeMonitoringPolicy": { + "failureAction": "Rollback", + "healthCheckRetryTimeout": "00:10:00", + "healthCheckWaitDuration": "00:02:00", + "healthCheckStableDuration": "00:05:00", + "upgradeDomainTimeout": "00:15:00", + "upgradeTimeout": "01:00:00" + }, + "upgradeReplicaSetCheckTimeout": 3600, + "forceRestart": false, + "instanceCloseDelayDuration": 600, + "upgradeMode": "UnmonitoredAuto", + "recreateApplication": false + } + } + } + }, + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/9c2ce367-47ea-43de-b69e-c5a423da4557?api-version=2021-11-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applications", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp", + "name": "myApp", + "tags": { + "a": "b" + }, + "properties": { + "provisioningState": "Updating", + "version": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0", + "parameters": { + "param1": "value1" + }, + "upgradePolicy": { + "applicationHealthPolicy": { + "considerWarningAsError": true, + "maxPercentUnhealthyDeployedApplications": 0, + "defaultServiceTypeHealthPolicy": { + "maxPercentUnhealthyServices": 0, + "maxPercentUnhealthyPartitionsPerService": 0, + "maxPercentUnhealthyReplicasPerPartition": 0 + }, + "serviceTypeHealthPolicyMap": { + "service1": { + "maxPercentUnhealthyReplicasPerPartition": 30, + "maxPercentUnhealthyPartitionsPerService": 30, + "maxPercentUnhealthyServices": 30 + } + } + }, + "rollingUpgradeMonitoringPolicy": { + "failureAction": "Rollback", + "healthCheckRetryTimeout": "00:10:00", + "healthCheckWaitDuration": "00:02:00", + "healthCheckStableDuration": "00:05:00", + "upgradeDomainTimeout": "00:15:00", + "upgradeTimeout": "01:00:00" + }, + "upgradeReplicaSetCheckTimeout": 3600, + "forceRestart": false, + "instanceCloseDelayDuration": 600, + "upgradeMode": "UnmonitoredAuto", + "recreateApplication": false + } + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationPutOperation_example_min.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationPutOperation_example_min.json new file mode 100644 index 000000000000..40d5baa9d093 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationPutOperation_example_min.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "api-version": "2021-11-01-preview", + "parameters": { + "location": "eastus", + "properties": { + "version": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp", + "name": "myApp", + "properties": { + "provisioningState": "Updating", + "version": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0", + "parameters": { + "param1": "value1" + }, + "upgradePolicy": { + "applicationHealthPolicy": { + "considerWarningAsError": true, + "maxPercentUnhealthyDeployedApplications": 0, + "defaultServiceTypeHealthPolicy": { + "maxPercentUnhealthyServices": 0, + "maxPercentUnhealthyPartitionsPerService": 0, + "maxPercentUnhealthyReplicasPerPartition": 0 + }, + "serviceTypeHealthPolicyMap": { + "service1": { + "maxPercentUnhealthyReplicasPerPartition": 30, + "maxPercentUnhealthyPartitionsPerService": 30, + "maxPercentUnhealthyServices": 30 + } + } + }, + "rollingUpgradeMonitoringPolicy": { + "failureAction": "Rollback", + "healthCheckRetryTimeout": "00:10:00", + "healthCheckWaitDuration": "00:02:00", + "healthCheckStableDuration": "00:05:00", + "upgradeDomainTimeout": "00:15:00", + "upgradeTimeout": "01:00:00" + }, + "upgradeReplicaSetCheckTimeout": 3600, + "forceRestart": false, + "instanceCloseDelayDuration": 600, + "upgradeMode": "UnmonitoredAuto", + "recreateApplication": false + } + } + } + }, + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/5dce62ce-439b-47af-81d8-99ab14708e91?api-version=2021-11-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applications", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp", + "name": "myCluster", + "properties": { + "provisioningState": "Updating", + "version": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0" + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationTypeNameDeleteOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationTypeNameDeleteOperation_example.json new file mode 100644 index 000000000000..38c6410482f0 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationTypeNameDeleteOperation_example.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationTypeName": "myAppType", + "api-version": "2021-11-01-preview" + }, + "responses": { + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/6a367b2d-9f60-4941-b886-e348ddcb4127?api-version=2021-11-01-preview" + } + }, + "204": {}, + "200": {} + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationTypeNameGetOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationTypeNameGetOperation_example.json new file mode 100644 index 000000000000..49e5f38650e4 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationTypeNameGetOperation_example.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationTypeName": "myAppType", + "api-version": "2021-11-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applicationTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType", + "name": "myAppType", + "properties": { + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationTypeNameListOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationTypeNameListOperation_example.json new file mode 100644 index 000000000000..a3244fa4c9cd --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationTypeNameListOperation_example.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2021-11-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabric/managedClusters/applicationTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType", + "name": "myAppType", + "properties": { + "provisioningState": "Succeeded" + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationTypeNamePatchOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationTypeNamePatchOperation_example.json new file mode 100644 index 000000000000..70a702e5cabb --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationTypeNamePatchOperation_example.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationTypeName": "myAppType", + "api-version": "2021-11-01-preview", + "parameters": { + "tags": { + "a": "b" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applicationTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType", + "name": "myAppType", + "tags": { + "a": "b" + }, + "properties": { + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationTypeNamePutOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationTypeNamePutOperation_example.json new file mode 100644 index 000000000000..6695231fa894 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationTypeNamePutOperation_example.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationTypeName": "myAppType", + "api-version": "2021-11-01-preview", + "parameters": { + "location": "eastus" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applicationTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType", + "name": "myAppType", + "properties": { + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationTypeVersionDeleteOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationTypeVersionDeleteOperation_example.json new file mode 100644 index 000000000000..b999fa86ba45 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationTypeVersionDeleteOperation_example.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationTypeName": "myAppType", + "version": "1.0", + "api-version": "2021-11-01-preview" + }, + "responses": { + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/28e62369-ed8c-4aba-8c05-ab7d6238cc3d?api-version=2021-11-01-preview" + } + }, + "204": {}, + "200": {} + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationTypeVersionGetOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationTypeVersionGetOperation_example.json new file mode 100644 index 000000000000..357c90e6d725 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationTypeVersionGetOperation_example.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationTypeName": "myAppType", + "version": "1.0", + "api-version": "2021-11-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applicationTypes/versions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0", + "name": "1.0", + "properties": { + "provisioningState": "Updating", + "appPackageUrl": "http://fakelink.test.com/MyAppType" + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationTypeVersionListOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationTypeVersionListOperation_example.json new file mode 100644 index 000000000000..6b78beb6388f --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationTypeVersionListOperation_example.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationTypeName": "myAppType", + "api-version": "2021-11-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabric/managedClusters/applicationTypes/versions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0", + "name": "1.0", + "properties": { + "provisioningState": "Updating", + "appPackageUrl": "http://fakelink.test.com/MyAppType" + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationTypeVersionPatchOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationTypeVersionPatchOperation_example.json new file mode 100644 index 000000000000..32854dbb91e6 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationTypeVersionPatchOperation_example.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationTypeName": "myAppType", + "version": "1.0", + "api-version": "2021-11-01-preview", + "parameters": { + "tags": { + "a": "b" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applicationTypes/versions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0", + "name": "1.0", + "tags": { + "a": "b" + }, + "properties": { + "provisioningState": "Succeeded", + "appPackageUrl": "http://fakelink.test.com/MyAppType" + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationTypeVersionPutOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationTypeVersionPutOperation_example.json new file mode 100644 index 000000000000..e1136dc92b46 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ApplicationTypeVersionPutOperation_example.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationTypeName": "myAppType", + "version": "1.0", + "api-version": "2021-11-01-preview", + "parameters": { + "location": "eastus", + "properties": { + "appPackageUrl": "http://fakelink.test.com/MyAppType" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applicationTypes/versions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0", + "name": "1.0", + "properties": { + "provisioningState": "Creating", + "appPackageUrl": "http://fakelink.test.com/MyAppType" + } + } + }, + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/e2413c7e-d51b-40ac-8155-bc85bf8ae856?api-version=2021-11-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applicationTypes/versions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0", + "name": "1.0", + "properties": { + "provisioningState": "Updating", + "appPackageUrl": "http://fakelink.test.com/MyAppType" + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/DeleteNodes_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/DeleteNodes_example.json new file mode 100644 index 000000000000..1ee903cde3de --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/DeleteNodes_example.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "BE", + "api-version": "2021-11-01-preview", + "parameters": { + "nodes": [ + "BE_0", + "BE_3" + ] + } + }, + "responses": { + "202": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-11-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-11-01-preview" + } + }, + "200": {} + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ManagedClusterDeleteOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ManagedClusterDeleteOperation_example.json new file mode 100644 index 000000000000..0029e965937a --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ManagedClusterDeleteOperation_example.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2021-11-01-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-11-01-preview" + } + }, + "204": {}, + "200": {} + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ManagedClusterGetOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ManagedClusterGetOperation_example.json new file mode 100644 index 000000000000..d2f9a8d6e1d1 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ManagedClusterGetOperation_example.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2021-11-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502169240745\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterCodeVersion": "7.1.168.9494", + "clusterUpgradeMode": "Automatic", + "clusterUpgradeCadence": "Wave0", + "clusterState": "WaitingForNodes", + "dnsName": "myCluster", + "fqdn": "MyCluster.eastus.cloudapp.azure.com", + "clusterCertificateThumbprints": [ + "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + ], + "clientConnectionPort": 19000, + "httpGatewayConnectionPort": 19080, + "loadBalancingRules": [ + { + "frontendPort": 80, + "backendPort": 80, + "probePort": 80, + "protocol": "http", + "probeProtocol": "http" + }, + { + "frontendPort": 443, + "backendPort": 443, + "probePort": 443, + "protocol": "http", + "probeProtocol": "http" + }, + { + "frontendPort": 10000, + "backendPort": 10000, + "probePort": 10000, + "protocol": "tcp", + "probeProtocol": "tcp" + } + ], + "adminUserName": "vmadmin", + "fabricSettings": [ + { + "name": "ManagedIdentityTokenService", + "parameters": [ + { + "name": "IsEnabled", + "value": "true" + } + ] + } + ] + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ManagedClusterListByResourceGroupOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ManagedClusterListByResourceGroupOperation_example.json new file mode 100644 index 000000000000..b91f0dc556e0 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ManagedClusterListByResourceGroupOperation_example.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "api-version": "2021-11-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabric/managedClusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502169240745\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterCodeVersion": "7.1.168.9494", + "clusterUpgradeMode": "Automatic", + "clusterUpgradeCadence": "Wave0", + "clusterState": "WaitingForNodes", + "dnsName": "myCluster", + "fqdn": "MyCluster.eastus.cloudapp.azure.com", + "clusterCertificateThumbprints": [ + "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + ], + "clientConnectionPort": 19000, + "httpGatewayConnectionPort": 19080, + "loadBalancingRules": [], + "adminUserName": "vmadmin", + "fabricSettings": [ + { + "name": "ManagedIdentityTokenService", + "parameters": [ + { + "name": "IsEnabled", + "value": "true" + } + ] + } + ] + } + }, + { + "type": "Microsoft.ServiceFabric/managedClusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster2", + "name": "myCluster2", + "tags": {}, + "etag": "W/\"636462502164040075\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "2747e469-b24e-4039-8a0a-46151419523f", + "clusterCodeVersion": "7.1.168.9494", + "clusterUpgradeMode": "Automatic", + "clusterUpgradeCadence": "Wave0", + "clusterState": "WaitingForNodes", + "dnsName": "myCluster2", + "fqdn": "MyCluster.eastus.cloudapp.azure.com", + "clusterCertificateThumbprints": [ + "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + ], + "clientConnectionPort": 19000, + "httpGatewayConnectionPort": 19080, + "loadBalancingRules": [], + "adminUserName": "vmadmin", + "fabricSettings": [ + { + "name": "ManagedIdentityTokenService", + "parameters": [ + { + "name": "IsEnabled", + "value": "true" + } + ] + } + ] + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ManagedClusterListBySubscriptionOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ManagedClusterListBySubscriptionOperation_example.json new file mode 100644 index 000000000000..8bda9d3b655c --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ManagedClusterListBySubscriptionOperation_example.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-11-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabric/managedClusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502169240745\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterCodeVersion": "7.1.168.9494", + "clusterUpgradeMode": "Automatic", + "clusterUpgradeCadence": "Wave0", + "clusterState": "WaitingForNodes", + "dnsName": "myCluster", + "fqdn": "MyCluster.eastus.cloudapp.azure.com", + "clusterCertificateThumbprints": [ + "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + ], + "clientConnectionPort": 19000, + "httpGatewayConnectionPort": 19080, + "loadBalancingRules": [], + "adminUserName": "vmadmin", + "fabricSettings": [ + { + "name": "ManagedIdentityTokenService", + "parameters": [ + { + "name": "IsEnabled", + "value": "true" + } + ] + } + ] + } + }, + { + "type": "Microsoft.ServiceFabric/managedClusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster2", + "name": "myCluster2", + "tags": {}, + "etag": "W/\"636462502164040075\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "2747e469-b24e-4039-8a0a-46151419523f", + "clusterCodeVersion": "7.1.168.9494", + "clusterUpgradeMode": "Automatic", + "clusterUpgradeCadence": "Wave0", + "clusterState": "WaitingForNodes", + "dnsName": "myCluster2", + "fqdn": "MyCluster.eastus.cloudapp.azure.com", + "clusterCertificateThumbprints": [ + "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + ], + "clientConnectionPort": 19000, + "httpGatewayConnectionPort": 19080, + "loadBalancingRules": [], + "adminUserName": "vmadmin", + "fabricSettings": [ + { + "name": "ManagedIdentityTokenService", + "parameters": [ + { + "name": "IsEnabled", + "value": "true" + } + ] + } + ] + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ManagedClusterPatchOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ManagedClusterPatchOperation_example.json new file mode 100644 index 000000000000..2ece99ffd15e --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ManagedClusterPatchOperation_example.json @@ -0,0 +1,106 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2021-11-01-preview", + "parameters": { + "tags": { + "a": "b" + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ServiceFabric/managedClusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster", + "name": "myCluster", + "tags": { + "a": "b" + }, + "etag": "W/\"636462502169240745\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterCodeVersion": "7.1.168.9494", + "clusterUpgradeMode": "Automatic", + "clusterUpgradeCadence": "Wave0", + "clusterState": "WaitingForNodes", + "dnsName": "myCluster", + "fqdn": "MyCluster.eastus.cloudapp.azure.com", + "clusterCertificateThumbprints": [ + "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + ], + "clientConnectionPort": 19001, + "httpGatewayConnectionPort": 19081, + "loadBalancingRules": [ + { + "frontendPort": 80, + "backendPort": 80, + "probePort": 80, + "protocol": "http", + "probeProtocol": "http" + }, + { + "frontendPort": 443, + "backendPort": 443, + "probePort": 443, + "protocol": "http", + "probeProtocol": "http" + }, + { + "frontendPort": 10000, + "backendPort": 10000, + "probePort": 10000, + "protocol": "tcp", + "probeProtocol": "http" + } + ], + "allowRdpAccess": true, + "networkSecurityRules": [ + { + "name": "TestName", + "protocol": "tcp", + "access": "allow", + "priority": 1010, + "direction": "inbound", + "sourcePortRanges": [ + "*" + ], + "destinationPortRanges": [ + "*" + ], + "sourceAddressPrefixes": [ + "*" + ], + "destinationAddressPrefixes": [ + "*" + ], + "description": "Test description" + } + ], + "adminUserName": "vmadmin", + "fabricSettings": [ + { + "name": "ManagedIdentityTokenService", + "parameters": [ + { + "name": "IsEnabled", + "value": "false" + } + ] + } + ], + "addonFeatures": [ + "DnsService", + "BackupRestoreService", + "ResourceMonitorService" + ], + "enableAutoOSUpgrade": true + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ManagedClusterPutOperation_example_max.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ManagedClusterPutOperation_example_max.json new file mode 100644 index 000000000000..6634f5b826c2 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ManagedClusterPutOperation_example_max.json @@ -0,0 +1,384 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2021-11-01-preview", + "parameters": { + "location": "eastus", + "tags": {}, + "sku": { + "name": "Basic" + }, + "properties": { + "clusterUpgradeMode": "Manual", + "clusterCodeVersion": "7.1.168.9494", + "dnsName": "myCluster", + "adminUserName": "vmadmin", + "adminPassword": "{vm-password}", + "clientConnectionPort": 19000, + "httpGatewayConnectionPort": 19080, + "loadBalancingRules": [ + { + "frontendPort": 80, + "backendPort": 80, + "probePort": 80, + "protocol": "http", + "probeProtocol": "http" + }, + { + "frontendPort": 443, + "backendPort": 443, + "probePort": 443, + "protocol": "http", + "probeProtocol": "http" + }, + { + "frontendPort": 10000, + "backendPort": 10000, + "probePort": 10000, + "protocol": "tcp", + "probeProtocol": "http" + } + ], + "allowRdpAccess": true, + "networkSecurityRules": [ + { + "name": "TestName", + "protocol": "tcp", + "access": "allow", + "priority": 1010, + "direction": "inbound", + "sourcePortRanges": [ + "*" + ], + "destinationPortRanges": [ + "*" + ], + "sourceAddressPrefixes": [ + "*" + ], + "destinationAddressPrefixes": [ + "*" + ], + "description": "Test description" + }, + { + "name": "AllowARM", + "protocol": "*", + "sourcePortRange": "*", + "sourceAddressPrefix": "AzureResourceManager", + "destinationAddressPrefix": "*", + "destinationPortRange": "33500-33699", + "access": "allow", + "priority": 2002, + "direction": "inbound" + } + ], + "fabricSettings": [ + { + "name": "ManagedIdentityTokenService", + "parameters": [ + { + "name": "IsEnabled", + "value": "true" + } + ] + } + ], + "addonFeatures": [ + "DnsService", + "BackupRestoreService", + "ResourceMonitorService" + ], + "enableAutoOSUpgrade": true, + "applicationTypeVersionsCleanupPolicy": { + "maxUnusedVersionsToKeep": 3 + }, + "zonalResiliency": true, + "enableIpv6": true, + "ipTags": [ + { + "ipTagType": "FirstPartyUsage", + "tag": "SQL" + } + ] + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-11-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-11-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502169240745\"", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Updating", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterUpgradeMode": "Manual", + "clusterCodeVersion": "7.1.168.9494", + "clusterState": "WaitingForNodes", + "dnsName": "myCluster", + "fqdn": "MyCluster.eastus.cloudapp.azure.com", + "clusterCertificateThumbprints": [ + "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + ], + "clientConnectionPort": 19000, + "httpGatewayConnectionPort": 19080, + "loadBalancingRules": [ + { + "frontendPort": 80, + "backendPort": 80, + "probePort": 80, + "protocol": "http", + "probeProtocol": "http" + }, + { + "frontendPort": 443, + "backendPort": 443, + "probePort": 443, + "protocol": "http", + "probeProtocol": "http" + }, + { + "frontendPort": 10000, + "backendPort": 10000, + "probePort": 10000, + "protocol": "tcp", + "probeProtocol": "tcp" + } + ], + "allowRdpAccess": true, + "networkSecurityRules": [ + { + "name": "TestName", + "protocol": "tcp", + "access": "allow", + "priority": 1010, + "direction": "inbound", + "sourcePortRanges": [ + "*" + ], + "destinationPortRanges": [ + "*" + ], + "sourceAddressPrefixes": [ + "*" + ], + "destinationAddressPrefixes": [ + "*" + ], + "description": "Test description" + }, + { + "name": "AllowARM", + "protocol": "*", + "sourcePortRange": "*", + "sourceAddressPrefix": "AzureResourceManager", + "destinationAddressPrefix": "*", + "destinationPortRange": "33500-33699", + "access": "allow", + "priority": 2002, + "direction": "inbound" + } + ], + "adminUserName": "vmadmin", + "fabricSettings": [ + { + "name": "ManagedIdentityTokenService", + "parameters": [ + { + "name": "IsEnabled", + "value": "true" + } + ] + } + ], + "addonFeatures": [ + "DnsService", + "BackupRestoreService", + "ResourceMonitorService" + ], + "enableAutoOSUpgrade": true, + "applicationTypeVersionsCleanupPolicy": { + "maxUnusedVersionsToKeep": 3 + }, + "zonalResiliency": true, + "enableIpv6": true, + "enableServicePublicIP": true, + "ipTags": [ + { + "ipTagType": "FirstPartyUsage", + "tag": "SQL" + } + ], + "auxiliarySubnets": [ + { + "name": "testSubnet1", + "enableIpv6": true, + "privateEndpointNetworkPolicies": "enabled", + "privateLinkServiceNetworkPolicies": "enabled", + "networkSecurityGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/networkSecurityGroups/sn1" + } + ], + "serviceEndpoints": [ + { + "service": "Microsoft.Storage", + "locations": [ + "eastus2", + "usnorth" + ] + } + ] + } + } + }, + "200": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-11-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-11-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502169240745\"", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Creating", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterUpgradeMode": "Manual", + "clusterCodeVersion": "7.1.168.9494", + "clusterState": "WaitingForNodes", + "dnsName": "myCluster", + "fqdn": "MyCluster.eastus.cloudapp.azure.com", + "clusterCertificateThumbprints": [ + "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + ], + "clientConnectionPort": 19000, + "httpGatewayConnectionPort": 19080, + "loadBalancingRules": [ + { + "frontendPort": 80, + "backendPort": 80, + "probePort": 80, + "protocol": "http", + "probeProtocol": "http" + }, + { + "frontendPort": 443, + "backendPort": 443, + "probePort": 443, + "protocol": "http", + "probeProtocol": "http" + }, + { + "frontendPort": 10000, + "backendPort": 10000, + "probePort": 10000, + "protocol": "tcp", + "probeProtocol": "tcp" + } + ], + "allowRdpAccess": true, + "networkSecurityRules": [ + { + "name": "TestName", + "protocol": "tcp", + "access": "allow", + "priority": 1010, + "direction": "inbound", + "sourcePortRanges": [ + "*" + ], + "destinationPortRanges": [ + "*" + ], + "sourceAddressPrefixes": [ + "*" + ], + "destinationAddressPrefixes": [ + "*" + ], + "description": "Test description" + }, + { + "name": "AllowARM", + "protocol": "*", + "sourcePortRange": "*", + "sourceAddressPrefix": "AzureResourceManager", + "destinationAddressPrefix": "*", + "destinationPortRange": "33500-33699", + "access": "allow", + "priority": 2002, + "direction": "inbound" + } + ], + "adminUserName": "vmadmin", + "fabricSettings": [ + { + "name": "ManagedIdentityTokenService", + "parameters": [ + { + "name": "IsEnabled", + "value": "true" + } + ] + } + ], + "addonFeatures": [ + "DnsService", + "BackupRestoreService", + "ResourceMonitorService" + ], + "enableAutoOSUpgrade": true, + "applicationTypeVersionsCleanupPolicy": { + "maxUnusedVersionsToKeep": 3 + }, + "zonalResiliency": true, + "enableIpv6": true, + "enableServicePublicIP": true, + "ipv6Address": "0000:0000:0000:0000:0000:0000:0000:0000", + "ipTags": [ + { + "ipTagType": "FirstPartyUsage", + "tag": "SQL" + } + ], + "auxiliarySubnets": [ + { + "name": "testSubnet1", + "enableIpv6": true, + "privateEndpointNetworkPolicies": "enabled", + "privateLinkServiceNetworkPolicies": "enabled", + "networkSecurityGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/networkSecurityGroups/sn1" + } + ], + "serviceEndpoints": [ + { + "service": "Microsoft.Storage", + "locations": [ + "eastus2", + "usnorth" + ] + } + ] + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ManagedClusterPutOperation_example_min.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ManagedClusterPutOperation_example_min.json new file mode 100644 index 000000000000..1aecc6dc6056 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ManagedClusterPutOperation_example_min.json @@ -0,0 +1,119 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2021-11-01-preview", + "parameters": { + "location": "eastus", + "properties": { + "clusterUpgradeMode": "Automatic", + "clusterUpgradeCadence": "Wave1", + "dnsName": "myCluster", + "adminUserName": "vmadmin", + "adminPassword": "{vm-password}", + "fabricSettings": [ + { + "name": "ManagedIdentityTokenService", + "parameters": [ + { + "name": "IsEnabled", + "value": "true" + } + ] + } + ] + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-11-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-11-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502169240745\"", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Updating", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterUpgradeMode": "Automatic", + "clusterUpgradeCadence": "Wave1", + "clusterState": "WaitingForNodes", + "dnsName": "myCluster", + "fqdn": "MyCluster.eastus.cloudapp.azure.com", + "clusterCertificateThumbprints": [ + "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + ], + "clientConnectionPort": 19000, + "httpGatewayConnectionPort": 19080, + "loadBalancingRules": [], + "adminUserName": "vmadmin", + "fabricSettings": [ + { + "name": "ManagedIdentityTokenService", + "parameters": [ + { + "name": "IsEnabled", + "value": "true" + } + ] + } + ] + } + } + }, + "200": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-11-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-11-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502169240745\"", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Creating", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterUpgradeMode": "Automatic", + "clusterUpgradeCadence": "Wave1", + "clusterState": "WaitingForNodes", + "dnsName": "myCluster", + "fqdn": "MyCluster.eastus.cloudapp.azure.com", + "clusterCertificateThumbprints": [ + "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + ], + "clientConnectionPort": 19000, + "httpGatewayConnectionPort": 19080, + "loadBalancingRules": [], + "adminUserName": "vmadmin", + "fabricSettings": [ + { + "name": "ManagedIdentityTokenService", + "parameters": [ + { + "name": "IsEnabled", + "value": "true" + } + ] + } + ] + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ManagedClusterVersionGetByEnvironment_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ManagedClusterVersionGetByEnvironment_example.json new file mode 100644 index 000000000000..9967501edf88 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ManagedClusterVersionGetByEnvironment_example.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "environment": "Windows", + "clusterVersion": "7.2.477.9590", + "api-version": "2021-11-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Windows/managedClusterVersions/7.2.477.9590", + "name": "7.2.477.9590", + "type": "Microsoft.ServiceFabric/locations/environments/managedClusterVersions", + "properties": { + "supportExpiryUtc": "2021-11-30T00:00:00", + "osType": "Windows", + "clusterCodeVersion": "7.2.477.9590" + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ManagedClusterVersionGet_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ManagedClusterVersionGet_example.json new file mode 100644 index 000000000000..674451e15f83 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ManagedClusterVersionGet_example.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "clusterVersion": "7.2.477.9590", + "api-version": "2021-11-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Windows/managedClusterVersions/7.2.477.9590", + "name": "7.2.477.9590", + "type": "Microsoft.ServiceFabric/locations/environments/managedClusterVersions", + "properties": { + "supportExpiryUtc": "2021-11-30T00:00:00", + "osType": "Windows", + "clusterCodeVersion": "7.2.477.9590" + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ManagedClusterVersionListByEnvironment.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ManagedClusterVersionListByEnvironment.json new file mode 100644 index 000000000000..52ce3ede3159 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ManagedClusterVersionListByEnvironment.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "environment": "Windows", + "api-version": "2021-11-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Windows/managedClusterVersions/7.2.457.9590", + "name": "7.2.457.9590", + "type": "Microsoft.ServiceFabric/locations/environments/managedClusterVersions", + "properties": { + "supportExpiryUtc": "2021-11-30T00:00:00", + "osType": "Windows", + "clusterCodeVersion": "7.2.457.9590" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Windows/managedClusterVersions/7.2.477.9590", + "name": "7.2.477.9590", + "type": "Microsoft.ServiceFabric/locations/environments/managedClusterVersions", + "properties": { + "supportExpiryUtc": "2021-11-30T00:00:00", + "osType": "Windows", + "clusterCodeVersion": "7.2.477.9590" + } + } + ] + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ManagedClusterVersionList_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ManagedClusterVersionList_example.json new file mode 100644 index 000000000000..72b23a185b28 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ManagedClusterVersionList_example.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "api-version": "2021-11-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Windows/managedClusterVersions/7.2.457.9590", + "name": "7.2.457.9590", + "type": "Microsoft.ServiceFabric/locations/environments/managedClusterVersions", + "properties": { + "supportExpiryUtc": "2021-11-30T00:00:00", + "osType": "Windows", + "clusterCodeVersion": "7.2.457.9590" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Windows/managedClusterVersions/7.2.477.9590", + "name": "7.2.477.9590", + "type": "Microsoft.ServiceFabric/locations/environments/managedClusterVersions", + "properties": { + "supportExpiryUtc": "2021-11-30T00:00:00", + "osType": "Windows", + "clusterCodeVersion": "7.2.477.9590" + } + } + ] + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/NodeTypeDeleteOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/NodeTypeDeleteOperation_example.json new file mode 100644 index 000000000000..e139463a8138 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/NodeTypeDeleteOperation_example.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "BE", + "api-version": "2021-11-01-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-11-01-preview" + } + }, + "204": {}, + "200": {} + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/NodeTypeGetOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/NodeTypeGetOperation_example.json new file mode 100644 index 000000000000..cc049196893d --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/NodeTypeGetOperation_example.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "FE", + "api-version": "2021-11-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/FE", + "name": "FE", + "tags": {}, + "properties": { + "isPrimary": true, + "dataDiskSizeGB": 100, + "dataDiskType": "StandardSSD_LRS", + "placementProperties": {}, + "capacities": {}, + "vmSize": "Standard_D2", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter", + "vmImageVersion": "latest", + "vmInstanceCount": 5, + "isStateless": false, + "vmSecrets": [ + { + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.KeyVault/vaults/myVault" + }, + "vaultCertificates": [ + { + "certificateStore": "My", + "certificateUrl": "https://myVault.vault.azure.net:443/secrets/myCert/ef1a31d39e1f46bca33def54b6cda54c" + } + ] + } + ] + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/NodeTypeListOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/NodeTypeListOperation_example.json new file mode 100644 index 000000000000..517674f907ee --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/NodeTypeListOperation_example.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2021-11-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/FE", + "name": "FE", + "tags": {}, + "sku": { + "name": "Standard_P0", + "tier": "Standard", + "capacity": 5 + }, + "properties": { + "isPrimary": true, + "dataDiskSizeGB": 100, + "dataDiskType": "StandardSSD_LRS", + "placementProperties": {}, + "capacities": {}, + "vmSize": "Standard_D2", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter", + "vmImageVersion": "latest", + "vmInstanceCount": 5, + "isStateless": false + } + }, + { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": {}, + "sku": { + "name": "Standard_S0", + "tier": "Standard", + "capacity": 10 + }, + "properties": { + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "Premium_LRS", + "placementProperties": {}, + "capacities": {}, + "vmSize": "Standard_DS3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter-Server-Core", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "isStateless": false, + "vmSecrets": [ + { + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.KeyVault/vaults/myVault" + }, + "vaultCertificates": [ + { + "certificateStore": "My", + "certificateUrl": "https://myVault.vault.azure.net:443/secrets/myCert/ef1a31d39e1f46bca33def54b6cda54c" + } + ] + } + ], + "vmExtensions": [ + { + "name": "Microsoft.Azure.Geneva.GenevaMonitoring", + "properties": { + "autoUpgradeMinorVersion": true, + "publisher": "Microsoft.Azure.Geneva", + "type": "GenevaMonitoring", + "typeHandlerVersion": "2.0", + "settings": {} + } + } + ] + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/NodeTypePatchOperationAutoScale_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/NodeTypePatchOperationAutoScale_example.json new file mode 100644 index 000000000000..018a36470f36 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/NodeTypePatchOperationAutoScale_example.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "BE", + "api-version": "2021-11-01-preview", + "parameters": { + "tags": { + "a": "b" + }, + "sku": { + "name": "Standard_S0", + "tier": "Standard", + "capacity": 10 + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": { + "a": "b" + }, + "sku": { + "name": "Standard_S0", + "tier": "Standard", + "capacity": 10 + }, + "properties": { + "provisioningState": "Succeeded", + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "StandardSSD_LRS", + "placementProperties": { + "HasSSD": "true", + "NodeColor": "green", + "SomeProperty": "5" + }, + "capacities": { + "ClientConnections": "65536" + }, + "vmSize": "Standard_D3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter-Server-Core", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "isStateless": false, + "vmSecrets": [ + { + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.KeyVault/vaults/myVault" + }, + "vaultCertificates": [ + { + "certificateStore": "My", + "certificateUrl": "https://myVault.vault.azure.net:443/secrets/myCert/ef1a31d39e1f46bca33def54b6cda54c" + } + ] + } + ], + "vmExtensions": [ + { + "name": "Microsoft.Azure.Geneva.GenevaMonitoring", + "properties": { + "autoUpgradeMinorVersion": true, + "publisher": "Microsoft.Azure.Geneva", + "type": "GenevaMonitoring", + "typeHandlerVersion": "2.0", + "settings": {} + } + } + ], + "vmManagedIdentity": { + "userAssignedIdentities": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity" + ] + } + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/NodeTypePatchOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/NodeTypePatchOperation_example.json new file mode 100644 index 000000000000..aa4a571a17e0 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/NodeTypePatchOperation_example.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "BE", + "api-version": "2021-11-01-preview", + "parameters": { + "tags": { + "a": "b" + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": { + "a": "b" + }, + "properties": { + "provisioningState": "Succeeded", + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "StandardSSD_LRS", + "placementProperties": { + "HasSSD": "true", + "NodeColor": "green", + "SomeProperty": "5" + }, + "capacities": { + "ClientConnections": "65536" + }, + "vmSize": "Standard_D3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter-Server-Core", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "isStateless": false, + "vmSecrets": [ + { + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.KeyVault/vaults/myVault" + }, + "vaultCertificates": [ + { + "certificateStore": "My", + "certificateUrl": "https://myVault.vault.azure.net:443/secrets/myCert/ef1a31d39e1f46bca33def54b6cda54c" + } + ] + } + ], + "vmExtensions": [ + { + "name": "Microsoft.Azure.Geneva.GenevaMonitoring", + "properties": { + "autoUpgradeMinorVersion": true, + "publisher": "Microsoft.Azure.Geneva", + "type": "GenevaMonitoring", + "typeHandlerVersion": "2.0", + "settings": {} + } + } + ], + "vmManagedIdentity": { + "userAssignedIdentities": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity" + ] + } + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/NodeTypePutOperationAutoScale_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/NodeTypePutOperationAutoScale_example.json new file mode 100644 index 000000000000..9577a788a589 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/NodeTypePutOperationAutoScale_example.json @@ -0,0 +1,201 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "BE", + "api-version": "2021-11-01-preview", + "parameters": { + "properties": { + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "Premium_LRS", + "placementProperties": { + "HasSSD": "true", + "NodeColor": "green", + "SomeProperty": "5" + }, + "capacities": { + "ClientConnections": "65536" + }, + "vmSize": "Standard_DS3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter-Server-Core", + "vmImageVersion": "latest", + "vmInstanceCount": -1, + "isStateless": true, + "multiplePlacementGroups": true, + "vmSecrets": [ + { + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.KeyVault/vaults/myVault" + }, + "vaultCertificates": [ + { + "certificateStore": "My", + "certificateUrl": "https://myVault.vault.azure.net:443/secrets/myCert/ef1a31d39e1f46bca33def54b6cda54c" + } + ] + } + ], + "vmExtensions": [ + { + "name": "Microsoft.Azure.Geneva.GenevaMonitoring", + "properties": { + "autoUpgradeMinorVersion": true, + "publisher": "Microsoft.Azure.Geneva", + "type": "GenevaMonitoring", + "typeHandlerVersion": "2.0", + "settings": {} + } + } + ], + "vmManagedIdentity": { + "userAssignedIdentities": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity2" + ] + } + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-11-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-11-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": {}, + "sku": { + "name": "Standard_S2", + "tier": "Standard", + "capacity": 10 + }, + "properties": { + "provisioningState": "Updating", + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "Premium_LRS", + "placementProperties": { + "HasSSD": "true", + "NodeColor": "green", + "SomeProperty": "5" + }, + "capacities": { + "ClientConnections": "65536" + }, + "vmSize": "Standard_DS3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter-Server-Core", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "isStateless": true, + "multiplePlacementGroups": true, + "vmSecrets": [ + { + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.KeyVault/vaults/myVault" + }, + "vaultCertificates": [ + { + "certificateStore": "My", + "certificateUrl": "https://myVault.vault.azure.net:443/secrets/myCert/ef1a31d39e1f46bca33def54b6cda54c" + } + ] + } + ], + "vmExtensions": [ + { + "name": "Microsoft.Azure.Geneva.GenevaMonitoring", + "properties": { + "autoUpgradeMinorVersion": true, + "forceUpdateTag": "v.1.0", + "publisher": "Microsoft.Azure.Geneva", + "type": "GenevaMonitoring", + "typeHandlerVersion": "2.0", + "settings": {} + } + } + ] + } + } + }, + "200": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-11-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-11-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": {}, + "sku": { + "name": "Standard_S2", + "tier": "Standard", + "capacity": 10 + }, + "properties": { + "provisioningState": "Creating", + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "Premium_LRS", + "placementProperties": { + "HasSSD": "true", + "NodeColor": "green", + "SomeProperty": "5" + }, + "capacities": { + "ClientConnections": "65536" + }, + "vmSize": "Standard_DS3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter-Server-Core", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "isStateless": true, + "multiplePlacementGroups": true, + "vmSecrets": [ + { + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.KeyVault/vaults/myVault" + }, + "vaultCertificates": [ + { + "certificateStore": "My", + "certificateUrl": "https://myVault.vault.azure.net:443/secrets/myCert/ef1a31d39e1f46bca33def54b6cda54c" + } + ] + } + ], + "vmExtensions": [ + { + "name": "Microsoft.Azure.Geneva.GenevaMonitoring", + "properties": { + "autoUpgradeMinorVersion": true, + "forceUpdateTag": "v.1.0", + "publisher": "Microsoft.Azure.Geneva", + "type": "GenevaMonitoring", + "typeHandlerVersion": "2.0", + "settings": {} + } + } + ], + "vmManagedIdentity": { + "userAssignedIdentities": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity2" + ] + } + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/NodeTypePutOperation_example_max.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/NodeTypePutOperation_example_max.json new file mode 100644 index 000000000000..95dba4f1ac6b --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/NodeTypePutOperation_example_max.json @@ -0,0 +1,261 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "BE", + "api-version": "2021-11-01-preview", + "parameters": { + "properties": { + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "Premium_LRS", + "dataDiskLetter": "S", + "placementProperties": { + "HasSSD": "true", + "NodeColor": "green", + "SomeProperty": "5" + }, + "capacities": { + "ClientConnections": "65536" + }, + "vmSize": "Standard_DS3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter-Server-Core", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "enableEncryptionAtHost": true, + "isStateless": true, + "multiplePlacementGroups": true, + "vmSecrets": [ + { + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.KeyVault/vaults/myVault" + }, + "vaultCertificates": [ + { + "certificateStore": "My", + "certificateUrl": "https://myVault.vault.azure.net:443/secrets/myCert/ef1a31d39e1f46bca33def54b6cda54c" + } + ] + } + ], + "vmExtensions": [ + { + "name": "Microsoft.Azure.Geneva.GenevaMonitoring", + "properties": { + "autoUpgradeMinorVersion": true, + "publisher": "Microsoft.Azure.Geneva", + "type": "GenevaMonitoring", + "typeHandlerVersion": "2.0", + "settings": {} + } + } + ], + "vmManagedIdentity": { + "userAssignedIdentities": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity2" + ] + }, + "additionalDataDisks": [ + { + "lun": 1, + "diskType": "StandardSSD_LRS", + "diskSizeGB": 256, + "diskLetter": "F" + }, + { + "lun": 2, + "diskType": "Premium_LRS", + "diskSizeGB": 150, + "diskLetter": "G" + } + ] + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-11-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-11-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": {}, + "properties": { + "provisioningState": "Updating", + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "Premium_LRS", + "dataDiskLetter": "S", + "placementProperties": { + "HasSSD": "true", + "NodeColor": "green", + "SomeProperty": "5" + }, + "capacities": { + "ClientConnections": "65536" + }, + "vmSize": "Standard_DS3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter-Server-Core", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "enableEncryptionAtHost": true, + "isStateless": true, + "multiplePlacementGroups": true, + "vmSecrets": [ + { + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.KeyVault/vaults/myVault" + }, + "vaultCertificates": [ + { + "certificateStore": "My", + "certificateUrl": "https://myVault.vault.azure.net:443/secrets/myCert/ef1a31d39e1f46bca33def54b6cda54c" + } + ] + } + ], + "vmExtensions": [ + { + "name": "Microsoft.Azure.Geneva.GenevaMonitoring", + "properties": { + "autoUpgradeMinorVersion": true, + "forceUpdateTag": "v.1.0", + "publisher": "Microsoft.Azure.Geneva", + "type": "GenevaMonitoring", + "typeHandlerVersion": "2.0", + "settings": {} + } + } + ], + "vmManagedIdentity": { + "userAssignedIdentities": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity2" + ] + }, + "additionalDataDisks": [ + { + "lun": 1, + "diskType": "StandardSSD_LRS", + "diskSizeGB": 256, + "diskLetter": "F" + }, + { + "lun": 2, + "diskType": "Premium_LRS", + "diskSizeGB": 150, + "diskLetter": "G" + } + ], + "enableAcceleratedNetworking": true, + "frontendConfigurations": [ + { + "loadBalancerBackendAddressPoolId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/loadBalancers/test-LB/backendAddressPools/LoadBalancerBEAddressPool", + "loadBalancerInboundNatPoolId": " /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/loadBalancers/test-LB/inboundNatPools/LoadBalancerNATPool" + } + ], + "useDefaultPublicLoadBalancer": true + } + } + }, + "200": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-11-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-11-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": {}, + "properties": { + "provisioningState": "Creating", + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "Premium_LRS", + "dataDiskLetter": "S", + "placementProperties": { + "HasSSD": "true", + "NodeColor": "green", + "SomeProperty": "5" + }, + "capacities": { + "ClientConnections": "65536" + }, + "vmSize": "Standard_DS3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter-Server-Core", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "enableEncryptionAtHost": true, + "isStateless": true, + "multiplePlacementGroups": true, + "vmSecrets": [ + { + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.KeyVault/vaults/myVault" + }, + "vaultCertificates": [ + { + "certificateStore": "My", + "certificateUrl": "https://myVault.vault.azure.net:443/secrets/myCert/ef1a31d39e1f46bca33def54b6cda54c" + } + ] + } + ], + "vmExtensions": [ + { + "name": "Microsoft.Azure.Geneva.GenevaMonitoring", + "properties": { + "autoUpgradeMinorVersion": true, + "forceUpdateTag": "v.1.0", + "publisher": "Microsoft.Azure.Geneva", + "type": "GenevaMonitoring", + "typeHandlerVersion": "2.0", + "settings": {} + } + } + ], + "vmManagedIdentity": { + "userAssignedIdentities": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity2" + ] + }, + "additionalDataDisks": [ + { + "lun": 1, + "diskType": "StandardSSD_LRS", + "diskSizeGB": 256, + "diskLetter": "F" + }, + { + "lun": 2, + "diskType": "Premium_LRS", + "diskSizeGB": 150, + "diskLetter": "G" + } + ], + "enableAcceleratedNetworking": true, + "frontendConfigurations": [ + { + "loadBalancerBackendAddressPoolId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/loadBalancers/test-LB/backendAddressPools/LoadBalancerBEAddressPool", + "loadBalancerInboundNatPoolId": " /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/loadBalancers/test-LB/inboundNatPools/LoadBalancerNATPool" + } + ], + "useDefaultPublicLoadBalancer": true + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/NodeTypePutOperation_example_min.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/NodeTypePutOperation_example_min.json new file mode 100644 index 000000000000..6de620829ab8 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/NodeTypePutOperation_example_min.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "BE", + "api-version": "2021-11-01-preview", + "parameters": { + "properties": { + "isPrimary": false, + "dataDiskSizeGB": 200, + "vmSize": "Standard_D3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter-Server-Core", + "vmImageVersion": "latest", + "vmInstanceCount": 10 + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-11-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-11-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": {}, + "properties": { + "provisioningState": "Updating", + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "StandardSSD_LRS", + "placementProperties": {}, + "capacities": {}, + "vmSize": "Standard_D3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter-Server-Core", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "isStateless": false + } + } + }, + "200": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-11-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-11-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": {}, + "properties": { + "provisioningState": "Creating", + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "StandardSSD_LRS", + "placementProperties": {}, + "capacities": {}, + "vmSize": "Standard_D3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter-Server-Core", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "isStateless": false + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/NodeTypeSkusListOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/NodeTypeSkusListOperation_example.json new file mode 100644 index 000000000000..f8a0cefcf72c --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/NodeTypeSkusListOperation_example.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "BE", + "api-version": "2021-11-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "resourceType": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "sku": { + "name": "Standard_S0", + "tier": "Standard" + }, + "capacity": { + "minimum": 1, + "maximum": 100, + "default": 1, + "scaleType": "Automatic" + } + }, + { + "resourceType": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "sku": { + "name": "Standard_S1", + "tier": "Standard" + }, + "capacity": { + "minimum": 3, + "maximum": 300, + "default": 3, + "scaleType": "Automatic" + } + }, + { + "resourceType": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "sku": { + "name": "Standard_S2", + "tier": "Standard" + }, + "capacity": { + "minimum": 1, + "maximum": 1000, + "default": 1, + "scaleType": "Automatic" + } + }, + { + "resourceType": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "sku": { + "name": "Standard_S3", + "tier": "Standard" + }, + "capacity": { + "minimum": 3, + "maximum": 1000, + "default": 3, + "scaleType": "Automatic" + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/Operations_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/Operations_example.json new file mode 100644 index 000000000000..f2645113f16b --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/Operations_example.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.ServiceFabric/managedClusters/read", + "display": { + "provider": "Microsoft ServiceFabric", + "resource": "managedClusters", + "operation": "Read Cluster", + "description": "Read any Cluster" + } + }, + { + "name": "Microsoft.ServiceFabric/managedClusters/write", + "display": { + "provider": "Microsoft ServiceFabric", + "resource": "managedClusters", + "operation": "Create or Update Cluster", + "description": "Create or Update any Cluster" + } + }, + { + "name": "Microsoft.ServiceFabric/managedClusters/delete", + "display": { + "provider": "Microsoft ServiceFabric", + "resource": "managedClusters", + "operation": "Delete Cluster", + "description": "Delete any Cluster" + } + }, + { + "name": "Microsoft.ServiceFabric/nodeTypes/read", + "display": { + "provider": "Microsoft ServiceFabric", + "resource": "nodeTypes", + "operation": "Read Node type", + "description": "Read any Node type" + } + }, + { + "name": "Microsoft.ServiceFabric/nodeTypes/write", + "display": { + "provider": "Microsoft ServiceFabric", + "resource": "nodeTypes", + "operation": "Create or Update Node type", + "description": "Create or Update any Node type" + } + }, + { + "name": "Microsoft.ServiceFabric/nodeTypes/delete", + "display": { + "provider": "Microsoft ServiceFabric", + "resource": "nodeTypes", + "operation": "Delete Node type", + "description": "Delete any Node type" + } + }, + { + "name": "Microsoft.ServiceFabric/nodeTypes/restart/action", + "display": { + "provider": "Microsoft ServiceFabric", + "resource": "nodeTypes", + "operation": "Restart nodes from Node type", + "description": "Restart nodes from Node type" + } + }, + { + "name": "Microsoft.ServiceFabric/nodeTypes/reimage/action", + "display": { + "provider": "Microsoft ServiceFabric", + "resource": "nodeTypes", + "operation": "Reimage nodes from Node type", + "description": "Reimage nodes from Node type" + } + }, + { + "name": "Microsoft.ServiceFabric/nodeTypes/deleteNode/action", + "display": { + "provider": "Microsoft ServiceFabric", + "resource": "nodeTypes", + "operation": "Delete nodes from Node type", + "description": "Delete nodes from Node type" + } + } + ] + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ReimageNodes_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ReimageNodes_example.json new file mode 100644 index 000000000000..1ee903cde3de --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ReimageNodes_example.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "BE", + "api-version": "2021-11-01-preview", + "parameters": { + "nodes": [ + "BE_0", + "BE_3" + ] + } + }, + "responses": { + "202": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-11-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-11-01-preview" + } + }, + "200": {} + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/RestartNodes_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/RestartNodes_example.json new file mode 100644 index 000000000000..1ee903cde3de --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/RestartNodes_example.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "BE", + "api-version": "2021-11-01-preview", + "parameters": { + "nodes": [ + "BE_0", + "BE_3" + ] + } + }, + "responses": { + "202": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-11-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-11-01-preview" + } + }, + "200": {} + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ServiceDeleteOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ServiceDeleteOperation_example.json new file mode 100644 index 000000000000..f65d15a4b691 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ServiceDeleteOperation_example.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "serviceName": "myService", + "api-version": "2021-11-01-preview" + }, + "responses": { + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/41fa5ef9-7f34-4c36-a730-93e0bb757d22?api-version=2021-11-01-preview" + } + }, + "204": {}, + "200": {} + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ServiceGetOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ServiceGetOperation_example.json new file mode 100644 index 000000000000..5d568a74eb33 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ServiceGetOperation_example.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "serviceName": "myService", + "api-version": "2021-11-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applications/services", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp/services/myService", + "name": "myService", + "properties": { + "provisioningState": "Updating", + "serviceKind": "Stateless", + "placementConstraints": "NodeType==frontend", + "serviceTypeName": "myServiceType", + "partitionDescription": { + "partitionScheme": "Singleton" + }, + "serviceLoadMetrics": [ + { + "name": "metric1", + "weight": "Low" + } + ], + "servicePlacementPolicies": [], + "defaultMoveCost": "Medium", + "instanceCount": 5, + "servicePackageActivationMode": "SharedProcess" + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ServiceListOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ServiceListOperation_example.json new file mode 100644 index 000000000000..c300aa024ac4 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ServiceListOperation_example.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "api-version": "2021-11-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabric/managedClusters/applications/services", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp/services/myService", + "name": "myService", + "properties": { + "provisioningState": "Updating", + "serviceKind": "Stateless", + "serviceTypeName": "myServiceType", + "partitionDescription": { + "partitionScheme": "Singleton" + }, + "serviceLoadMetrics": [ + { + "name": "metric1", + "weight": "Low" + } + ], + "instanceCount": 1, + "servicePackageActivationMode": "SharedProcess" + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ServicePatchOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ServicePatchOperation_example.json new file mode 100644 index 000000000000..8e1a47b79242 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ServicePatchOperation_example.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "serviceName": "myService", + "api-version": "2021-11-01-preview", + "parameters": { + "tags": { + "a": "b" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applications/services", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp/services/myService", + "name": "myService", + "tags": { + "a": "b" + }, + "properties": { + "provisioningState": "Succeeded", + "serviceKind": "Stateless", + "placementConstraints": "NodeType==frontend", + "serviceTypeName": "myServiceType", + "partitionDescription": { + "partitionScheme": "Singleton" + }, + "serviceLoadMetrics": [ + { + "name": "metric1", + "weight": "Low", + "defaultLoad": 3 + } + ], + "correlationScheme": [ + { + "serviceName": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp/services/myService1", + "scheme": "AlignedAffinity" + } + ], + "servicePlacementPolicies": [ + { + "type": "NonPartiallyPlaceService" + } + ], + "scalingPolicies": [ + { + "scalingMechanism": { + "kind": "ScalePartitionInstanceCount", + "maxInstanceCount": 9, + "minInstanceCount": 3, + "scaleIncrement": 2 + }, + "scalingTrigger": { + "kind": "AveragePartitionLoadTrigger", + "lowerLoadThreshold": 2.0, + "metricName": "metricName", + "scaleInterval": "00:01:00", + "upperLoadThreshold": 8.0 + } + } + ], + "defaultMoveCost": "Medium", + "instanceCount": 5, + "minInstanceCount": 3, + "minInstancePercentage": 30, + "servicePackageActivationMode": "SharedProcess" + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ServicePutOperation_example_max.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ServicePutOperation_example_max.json new file mode 100644 index 000000000000..c421e7ac3dbc --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ServicePutOperation_example_max.json @@ -0,0 +1,189 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "serviceName": "myService", + "api-version": "2021-11-01-preview", + "parameters": { + "location": "eastus", + "tags": { + "a": "b" + }, + "properties": { + "serviceKind": "Stateless", + "placementConstraints": "NodeType==frontend", + "serviceTypeName": "myServiceType", + "partitionDescription": { + "partitionScheme": "Singleton" + }, + "serviceLoadMetrics": [ + { + "name": "metric1", + "weight": "Low", + "defaultLoad": 3 + } + ], + "correlationScheme": [ + { + "serviceName": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp/services/myService1", + "scheme": "AlignedAffinity" + } + ], + "servicePlacementPolicies": [ + { + "type": "NonPartiallyPlaceService" + } + ], + "scalingPolicies": [ + { + "scalingMechanism": { + "kind": "ScalePartitionInstanceCount", + "maxInstanceCount": 9, + "minInstanceCount": 3, + "scaleIncrement": 2 + }, + "scalingTrigger": { + "kind": "AveragePartitionLoadTrigger", + "lowerLoadThreshold": 2.0, + "metricName": "metricName", + "scaleInterval": "00:01:00", + "upperLoadThreshold": 8.0 + } + } + ], + "defaultMoveCost": "Medium", + "instanceCount": 5, + "minInstanceCount": 3, + "minInstancePercentage": 30, + "servicePackageActivationMode": "SharedProcess" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applications/services", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp/services/myService", + "name": "myService", + "tags": { + "a": "b" + }, + "properties": { + "provisioningState": "Creating", + "serviceKind": "Stateless", + "placementConstraints": "NodeType==frontend", + "serviceTypeName": "myServiceType", + "partitionDescription": { + "partitionScheme": "Singleton" + }, + "serviceLoadMetrics": [ + { + "name": "metric1", + "weight": "Low", + "defaultLoad": 3 + } + ], + "correlationScheme": [ + { + "serviceName": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp/services/myService1", + "scheme": "AlignedAffinity" + } + ], + "servicePlacementPolicies": [ + { + "type": "NonPartiallyPlaceService" + } + ], + "scalingPolicies": [ + { + "scalingMechanism": { + "kind": "ScalePartitionInstanceCount", + "maxInstanceCount": 9, + "minInstanceCount": 3, + "scaleIncrement": 2 + }, + "scalingTrigger": { + "kind": "AveragePartitionLoadTrigger", + "lowerLoadThreshold": 2.0, + "metricName": "metricName", + "scaleInterval": "00:01:00", + "upperLoadThreshold": 8.0 + } + } + ], + "defaultMoveCost": "Medium", + "instanceCount": 5, + "minInstanceCount": 3, + "minInstancePercentage": 30, + "servicePackageActivationMode": "SharedProcess" + } + } + }, + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/2e633105-aadc-4928-9164-d76b974170a3?api-version=2021-11-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applications/services", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp/services/myService", + "name": "myService", + "tags": { + "a": "b" + }, + "properties": { + "provisioningState": "Updating", + "serviceKind": "Stateless", + "placementConstraints": "NodeType==frontend", + "serviceTypeName": "myServiceType", + "partitionDescription": { + "partitionScheme": "Singleton" + }, + "serviceLoadMetrics": [ + { + "name": "metric1", + "weight": "Low", + "defaultLoad": 3 + } + ], + "correlationScheme": [ + { + "serviceName": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp/services/myService1", + "scheme": "AlignedAffinity" + } + ], + "servicePlacementPolicies": [ + { + "type": "NonPartiallyPlaceService" + } + ], + "scalingPolicies": [ + { + "scalingMechanism": { + "kind": "ScalePartitionInstanceCount", + "maxInstanceCount": 9, + "minInstanceCount": 3, + "scaleIncrement": 2 + }, + "scalingTrigger": { + "kind": "AveragePartitionLoadTrigger", + "lowerLoadThreshold": 2.0, + "metricName": "metricName", + "scaleInterval": "00:01:00", + "upperLoadThreshold": 8.0 + } + } + ], + "defaultMoveCost": "Medium", + "instanceCount": 5, + "minInstanceCount": 3, + "minInstancePercentage": 30, + "servicePackageActivationMode": "SharedProcess" + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ServicePutOperation_example_min.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ServicePutOperation_example_min.json new file mode 100644 index 000000000000..6c712637d5cf --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/ServicePutOperation_example_min.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "serviceName": "myService", + "api-version": "2021-11-01-preview", + "parameters": { + "location": "eastus", + "properties": { + "serviceKind": "Stateless", + "serviceTypeName": "myServiceType", + "partitionDescription": { + "partitionScheme": "Singleton" + }, + "instanceCount": 1 + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applications/services", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp/services/myService", + "name": "myService", + "properties": { + "provisioningState": "Creating", + "serviceKind": "Stateless", + "serviceTypeName": "myServiceType", + "partitionDescription": { + "partitionScheme": "Singleton" + }, + "instanceCount": 1 + } + } + }, + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/5bc615c3-6c5b-4593-80e1-008f55376ec7?api-version=2021-11-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applications/services", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp/services/myService", + "name": "myService", + "properties": { + "provisioningState": "Updating", + "serviceKind": "Stateless", + "serviceTypeName": "myServiceType", + "partitionDescription": { + "partitionScheme": "Singleton" + }, + "instanceCount": 1 + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/managedUnsupportedVMSizesGet_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/managedUnsupportedVMSizesGet_example.json new file mode 100644 index 000000000000..954deca71243 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/managedUnsupportedVMSizesGet_example.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "api-version": "2021-11-01-preview", + "vmSize": "Standard_B1ls1" + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Standard_B1ls1", + "name": "Standard_B1ls1", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Standard_B1ls1" + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/managedUnsupportedVMSizesList_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/managedUnsupportedVMSizesList_example.json new file mode 100644 index 000000000000..7f59c760b912 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/examples/managedUnsupportedVMSizesList_example.json @@ -0,0 +1,175 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "api-version": "2021-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Standard_B1ls1", + "name": "Standard_B1ls1", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Standard_B1ls1" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Standard_B1s", + "name": "Standard_B1s", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Standard_B1s" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Standard_B1ms", + "name": "Standard_B1ms", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Standard_B1ms" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Standard_B2s", + "name": "Standard_B2s", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Standard_B2s" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Standard_B2ms", + "name": "Standard_B2ms", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Standard_B2ms" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Standard_B4ms", + "name": "Standard_B4ms", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Standard_B4ms" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Standard_B8ms", + "name": "Standard_B8ms", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Standard_B8ms" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Standard_A1_v2", + "name": "Standard_A1_v2", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Standard_A1_v2" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Standard_A2_v2", + "name": "Standard_A2_v2", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Standard_A2_v2" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Standard_A4_v2", + "name": "Standard_A4_v2", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Standard_A4_v2" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Standard_A8_v2", + "name": "Standard_A8_v2", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Standard_A8_v2" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Standard_A2m_v2", + "name": "Standard_A2m_v2", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Standard_A2m_v2" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Standard_A4m_v2", + "name": "Standard_A4m_v2", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Standard_A4m_v2" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Standard_A8m_v2", + "name": "Standard_A8m_v2", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Standard_A8m_v2" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Basic_A0", + "name": "Basic_A0", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Basic_A0" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Basic_A1", + "name": "Basic_A1", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Basic_A1" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Basic_A2", + "name": "Basic_A2", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Basic_A2" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Basic_A3", + "name": "Basic_A3", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Basic_A3" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Basic_A4", + "name": "Basic_A4", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Basic_A4" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Standard_A0", + "name": "Standard_A0", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Standard_A0" + } + } + ] + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/managedapplication.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/managedapplication.json new file mode 100644 index 000000000000..517f40ef397d --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/managedapplication.json @@ -0,0 +1,2726 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceFabricManagementClient", + "description": "Azure Service Fabric Resource Provider API Client", + "version": "2021-11-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "type": "oauth2" + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applicationTypes/{applicationTypeName}": { + "get": { + "tags": [ + "ApplicationType" + ], + "operationId": "ApplicationTypes_Get", + "summary": "Gets a Service Fabric managed application type name resource.", + "description": "Get a Service Fabric application type name resource created or in the process of being created in the Service Fabric managed cluster resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Get an application type": { + "$ref": "./examples/ApplicationTypeNameGetOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationTypeResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "put": { + "tags": [ + "ApplicationType" + ], + "operationId": "ApplicationTypes_CreateOrUpdate", + "summary": "Creates or updates a Service Fabric managed application type name resource.", + "description": "Create or update a Service Fabric managed application type name resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The application type name resource.", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationTypeResource" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Put an application type": { + "$ref": "./examples/ApplicationTypeNamePutOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationTypeResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "patch": { + "tags": [ + "ApplicationType" + ], + "operationId": "ApplicationTypes_Update", + "summary": "Updates the tags of an application type resource of a given managed cluster.", + "description": "Updates the tags of an application type resource of a given managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The application type resource updated tags.", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationTypeUpdateParameters" + } + } + ], + "x-ms-examples": { + "Patch an application type": { + "$ref": "./examples/ApplicationTypeNamePatchOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationTypeResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "tags": [ + "ApplicationType" + ], + "operationId": "ApplicationTypes_Delete", + "summary": "Deletes a Service Fabric managed application type name resource.", + "description": "Delete a Service Fabric managed application type name resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Delete an application type": { + "$ref": "./examples/ApplicationTypeNameDeleteOperation_example.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously." + }, + "204": { + "description": "The resource was not found." + }, + "200": { + "description": "The operation completed successfully." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applicationTypes": { + "get": { + "tags": [ + "ApplicationType" + ], + "operationId": "ApplicationTypes_List", + "summary": "Gets the list of application type name resources created in the specified Service Fabric managed cluster resource.", + "description": "Gets all application type name resources created or in the process of being created in the Service Fabric managed cluster resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get a list of application type name resources": { + "$ref": "./examples/ApplicationTypeNameListOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationTypeResourceList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applicationTypes/{applicationTypeName}/versions/{version}": { + "get": { + "tags": [ + "ApplicationTypeVersion" + ], + "operationId": "ApplicationTypeVersions_Get", + "summary": "Gets a Service Fabric managed application type version resource.", + "description": "Get a Service Fabric managed application type version resource created or in the process of being created in the Service Fabric managed application type name resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/version" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Get an application type version": { + "$ref": "./examples/ApplicationTypeVersionGetOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationTypeVersionResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "put": { + "tags": [ + "ApplicationTypeVersion" + ], + "operationId": "ApplicationTypeVersions_CreateOrUpdate", + "summary": "Creates or updates a Service Fabric managed application type version resource.", + "description": "Create or update a Service Fabric managed application type version resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/version" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The application type version resource.", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationTypeVersionResource" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Put an application type version": { + "$ref": "./examples/ApplicationTypeVersionPutOperation_example.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationTypeVersionResource" + } + }, + "202": { + "description": "The request was accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ApplicationTypeVersionResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "patch": { + "tags": [ + "ApplicationTypeVersion" + ], + "operationId": "ApplicationTypeVersions_Update", + "summary": "Updates the tags of an application type version resource of a given managed cluster.", + "description": "Updates the tags of an application type version resource of a given managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/version" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The application type version resource updated tags.", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationTypeVersionUpdateParameters" + } + } + ], + "x-ms-examples": { + "Patch an application type version": { + "$ref": "./examples/ApplicationTypeVersionPatchOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationTypeVersionResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "tags": [ + "ApplicationTypeVersion" + ], + "operationId": "ApplicationTypeVersions_Delete", + "summary": "Deletes a Service Fabric managed application type version resource.", + "description": "Delete a Service Fabric managed application type version resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/version" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Delete an application type version": { + "$ref": "./examples/ApplicationTypeVersionDeleteOperation_example.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously." + }, + "204": { + "description": "The resource was not found." + }, + "200": { + "description": "The operation completed successfully." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applicationTypes/{applicationTypeName}/versions": { + "get": { + "tags": [ + "ApplicationTypeVersion" + ], + "operationId": "ApplicationTypeVersions_ListByApplicationTypes", + "summary": "Gets the list of application type version resources created in the specified Service Fabric managed application type name resource.", + "description": "Gets all application type version resources created or in the process of being created in the Service Fabric managed application type name resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get a list of application type version resources": { + "$ref": "./examples/ApplicationTypeVersionListOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationTypeVersionResourceList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applications/{applicationName}": { + "get": { + "tags": [ + "Application" + ], + "operationId": "Applications_Get", + "summary": "Gets a Service Fabric managed application resource.", + "description": "Get a Service Fabric managed application resource created or in the process of being created in the Service Fabric cluster resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Get an application": { + "$ref": "./examples/ApplicationGetOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "put": { + "tags": [ + "Application" + ], + "operationId": "Applications_CreateOrUpdate", + "summary": "Creates or updates a Service Fabric managed application resource.", + "description": "Create or update a Service Fabric managed application resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The application resource.", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationResource" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Put an application with minimum parameters": { + "$ref": "./examples/ApplicationPutOperation_example_min.json" + }, + "Put an application with maximum parameters": { + "$ref": "./examples/ApplicationPutOperation_example_max.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationResource" + } + }, + "202": { + "description": "The request was accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ApplicationResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "patch": { + "tags": [ + "Application" + ], + "operationId": "Applications_Update", + "summary": "Updates the tags of an application resource of a given managed cluster.", + "description": "Updates the tags of an application resource of a given managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The application resource updated tags.", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationUpdateParameters" + } + } + ], + "x-ms-examples": { + "Patch an application": { + "$ref": "./examples/ApplicationPatchOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "tags": [ + "Application" + ], + "operationId": "Applications_Delete", + "summary": "Deletes a Service Fabric managed application resource.", + "description": "Delete a Service Fabric managed application resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Delete an application": { + "$ref": "./examples/ApplicationDeleteOperation_example.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously." + }, + "204": { + "description": "The resource was not found." + }, + "200": { + "description": "The operation completed successfully." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applications": { + "get": { + "tags": [ + "Application" + ], + "operationId": "Applications_List", + "summary": "Gets the list of managed application resources created in the specified Service Fabric cluster resource.", + "description": "Gets all managed application resources created or in the process of being created in the Service Fabric cluster resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get a list of application resources": { + "$ref": "./examples/ApplicationListOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationResourceList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applications/{applicationName}/services/{serviceName}": { + "get": { + "tags": [ + "Service" + ], + "operationId": "Services_Get", + "summary": "Gets a Service Fabric managed service resource.", + "description": "Get a Service Fabric service resource created or in the process of being created in the Service Fabric managed application resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/serviceName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Get a service": { + "$ref": "./examples/ServiceGetOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServiceResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "put": { + "tags": [ + "Service" + ], + "operationId": "Services_CreateOrUpdate", + "summary": "Creates or updates a Service Fabric managed service resource.", + "description": "Create or update a Service Fabric managed service resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/serviceName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The service resource.", + "required": true, + "schema": { + "$ref": "#/definitions/ServiceResource" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Put a service with minimum parameters": { + "$ref": "./examples/ServicePutOperation_example_min.json" + }, + "Put a service with maximum parameters": { + "$ref": "./examples/ServicePutOperation_example_max.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServiceResource" + } + }, + "202": { + "description": "The request was accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ServiceResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "patch": { + "tags": [ + "Services" + ], + "operationId": "Services_Update", + "summary": "Updates the tags of a service resource of a given managed cluster.", + "description": "Updates the tags of a service resource of a given managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/serviceName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The service resource updated tags.", + "required": true, + "schema": { + "$ref": "#/definitions/ServiceUpdateParameters" + } + } + ], + "x-ms-examples": { + "Patch a service": { + "$ref": "./examples/ServicePatchOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServiceResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "tags": [ + "Service" + ], + "operationId": "Services_Delete", + "summary": "Deletes a Service Fabric managed service resource.", + "description": "Delete a Service Fabric managed service resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/serviceName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Delete a service": { + "$ref": "./examples/ServiceDeleteOperation_example.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously." + }, + "204": { + "description": "The resource was not found." + }, + "200": { + "description": "The operation completed successfully." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applications/{applicationName}/services": { + "get": { + "tags": [ + "Service" + ], + "operationId": "Services_ListByApplications", + "summary": "Gets the list of service resources created in the specified Service Fabric managed application resource.", + "description": "Gets all service resources created or in the process of being created in the Service Fabric managed application resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Get a list of service resources": { + "$ref": "./examples/ServiceListOperation_example.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServiceResourceList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + } + }, + "definitions": { + "AddRemoveIncrementalNamedPartitionScalingMechanism": { + "type": "object", + "description": "Represents a scaling mechanism for adding or removing named partitions of a stateless service. Partition names are in the format '0','1'...'N-1'.", + "allOf": [ + { + "$ref": "#/definitions/ScalingMechanism" + }, + { + "type": "object", + "description": "AddRemoveIncrementalNamedPartitionScalingMechanism" + } + ], + "x-ms-discriminator-value": "AddRemoveIncrementalNamedPartition", + "required": [ + "minPartitionCount", + "maxPartitionCount", + "scaleIncrement" + ], + "properties": { + "minPartitionCount": { + "type": "integer", + "format": "int32", + "description": "Minimum number of named partitions of the service." + }, + "maxPartitionCount": { + "type": "integer", + "format": "int32", + "description": "Maximum number of named partitions of the service." + }, + "scaleIncrement": { + "type": "integer", + "format": "int32", + "description": "The number of instances to add or remove during a scaling operation." + } + } + }, + "ApplicationHealthPolicy": { + "type": "object", + "description": "Defines a health policy used to evaluate the health of an application or one of its children entities.\n", + "required": [ + "considerWarningAsError", + "maxPercentUnhealthyDeployedApplications" + ], + "properties": { + "considerWarningAsError": { + "type": "boolean", + "description": "Indicates whether warnings are treated with the same severity as errors." + }, + "maxPercentUnhealthyDeployedApplications": { + "type": "integer", + "format": "int32", + "description": "The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100.\nThe percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error.\nThis 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.\nThe computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero.\n" + }, + "defaultServiceTypeHealthPolicy": { + "$ref": "#/definitions/ServiceTypeHealthPolicy", + "description": "The health policy used by default to evaluate the health of a service type." + }, + "serviceTypeHealthPolicyMap": { + "$ref": "#/definitions/ServiceTypeHealthPolicyMap", + "description": "The map with service type health policy per service type name. The map is empty by default." + } + } + }, + "ApplicationParameterList": { + "type": "object", + "description": "List of application parameters with overridden values from their default values specified in the application manifest.", + "additionalProperties": { + "type": "string" + } + }, + "ApplicationResource": { + "type": "object", + "description": "The application resource.", + "properties": { + "identity": { + "$ref": "#/definitions/ManagedIdentity" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationResourceProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ] + }, + "ApplicationResourceList": { + "type": "object", + "description": "The list of application resources.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationResource" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of application list results if there are any.", + "readOnly": true + } + } + }, + "ApplicationResourceProperties": { + "type": "object", + "description": "The application resource properties.", + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current deployment or provisioning state, which only appears in the response" + }, + "version": { + "$ref": "#/definitions/ApplicationTypeVersion" + }, + "parameters": { + "$ref": "#/definitions/ApplicationParameterList" + }, + "upgradePolicy": { + "$ref": "#/definitions/ApplicationUpgradePolicy" + }, + "managedIdentities": { + "description": "List of user assigned identities for the application, each mapped to a friendly name.", + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationUserAssignedIdentity" + } + } + } + }, + "ApplicationTypeResource": { + "type": "object", + "description": "The application type name resource", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationTypeResourceProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ] + }, + "ApplicationTypeResourceList": { + "type": "object", + "description": "The list of application type names.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationTypeResource" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of application type list results if there are any.", + "readOnly": true + } + } + }, + "ApplicationTypeResourceProperties": { + "type": "object", + "description": "The application type name properties", + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current deployment or provisioning state, which only appears in the response." + } + } + }, + "ApplicationTypeUpdateParameters": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "description": "Application type update parameters", + "additionalProperties": { + "type": "string" + } + } + }, + "description": "Application type update request" + }, + "ApplicationTypeVersion": { + "type": "string", + "description": "The version of the application type as defined in the application manifest.\nThis name must be the full Arm Resource ID for the referenced application type version.\n" + }, + "ApplicationTypeVersionResource": { + "type": "object", + "description": "An application type version resource for the specified application type name resource.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationTypeVersionResourceProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ] + }, + "ApplicationTypeVersionResourceList": { + "type": "object", + "description": "The list of application type version resources for the specified application type name resource.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationTypeVersionResource" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of application type version list results if there are any.", + "readOnly": true + } + } + }, + "ApplicationTypeVersionResourceProperties": { + "type": "object", + "description": "The properties of the application type version resource.", + "required": [ + "appPackageUrl" + ], + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current deployment or provisioning state, which only appears in the response" + }, + "appPackageUrl": { + "type": "string", + "description": "The URL to the application package" + } + } + }, + "ApplicationTypeVersionUpdateParameters": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "description": "Application type version update parameters", + "additionalProperties": { + "type": "string" + } + } + }, + "description": "Application type version update request" + }, + "ApplicationUpdateParameters": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "description": "Application update parameters", + "additionalProperties": { + "type": "string" + } + } + }, + "description": "Application update request" + }, + "ApplicationUpgradePolicy": { + "type": "object", + "description": "Describes the policy for a monitored application upgrade.", + "properties": { + "applicationHealthPolicy": { + "$ref": "#/definitions/ApplicationHealthPolicy" + }, + "forceRestart": { + "$ref": "#/definitions/ForceRestart" + }, + "rollingUpgradeMonitoringPolicy": { + "$ref": "#/definitions/RollingUpgradeMonitoringPolicy" + }, + "instanceCloseDelayDuration": { + "type": "integer", + "format": "int64", + "description": "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." + }, + "upgradeMode": { + "$ref": "#/definitions/RollingUpgradeMode" + }, + "upgradeReplicaSetCheckTimeout": { + "type": "integer", + "format": "int64", + "description": "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)." + }, + "recreateApplication": { + "type": "boolean", + "description": "Determines whether the application should be recreated on update. If value=true, the rest of the upgrade policy parameters are not allowed." + } + } + }, + "ApplicationUserAssignedIdentity": { + "type": "object", + "required": [ + "name", + "principalId" + ], + "properties": { + "name": { + "type": "string", + "description": "The friendly name of user assigned identity." + }, + "principalId": { + "type": "string", + "description": "The principal id of user assigned identity." + } + } + }, + "AveragePartitionLoadScalingTrigger": { + "type": "object", + "description": "Represents a scaling trigger related to an average load of a metric/resource of a partition.", + "allOf": [ + { + "$ref": "#/definitions/ScalingTrigger" + }, + { + "type": "object", + "description": "AveragePartitionLoadScalingTrigger" + } + ], + "x-ms-discriminator-value": "AveragePartitionLoadTrigger", + "required": [ + "metricName", + "lowerLoadThreshold", + "upperLoadThreshold", + "scaleInterval" + ], + "properties": { + "metricName": { + "type": "string", + "description": "The name of the metric for which usage should be tracked." + }, + "lowerLoadThreshold": { + "type": "number", + "format": "double", + "description": "The lower limit of the load below which a scale in operation should be performed." + }, + "upperLoadThreshold": { + "type": "number", + "format": "double", + "description": "The upper limit of the load beyond which a scale out operation should be performed." + }, + "scaleInterval": { + "type": "string", + "description": "The period in seconds on which a decision is made whether to scale or not. This property should come in ISO 8601 format \"hh:mm:ss\"." + } + } + }, + "AverageServiceLoadScalingTrigger": { + "type": "object", + "description": "Represents a scaling policy related to an average load of a metric/resource of a service.", + "allOf": [ + { + "$ref": "#/definitions/ScalingTrigger" + }, + { + "type": "object", + "description": "AverageServiceLoadScalingTrigger" + } + ], + "x-ms-discriminator-value": "AverageServiceLoadTrigger", + "required": [ + "metricName", + "lowerLoadThreshold", + "upperLoadThreshold", + "scaleInterval", + "useOnlyPrimaryLoad" + ], + "properties": { + "metricName": { + "type": "string", + "description": "The name of the metric for which usage should be tracked." + }, + "lowerLoadThreshold": { + "type": "number", + "format": "double", + "description": "The lower limit of the load below which a scale in operation should be performed." + }, + "upperLoadThreshold": { + "type": "number", + "format": "double", + "description": "The upper limit of the load beyond which a scale out operation should be performed." + }, + "scaleInterval": { + "type": "string", + "description": "The period in seconds on which a decision is made whether to scale or not. This property should come in ISO 8601 format \"hh:mm:ss\"." + }, + "useOnlyPrimaryLoad": { + "type": "boolean", + "description": "Flag determines whether only the load of primary replica should be considered for scaling. If set to true, then trigger will only consider the load of primary replicas of stateful service. If set to false, trigger will consider load of all replicas. This parameter cannot be set to true for stateless service." + } + } + }, + "CorrelationSchemeList": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceCorrelation" + }, + "description": "A list that describes the correlation of the service with other services." + }, + "ForceRestart": { + "type": "boolean", + "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).", + "default": false + }, + "HealthCheckRetryTimeout": { + "type": "string", + "description": "The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is interpreted as a string representing an ISO 8601 duration with following format \"hh:mm:ss.fff\"." + }, + "HealthCheckStableDuration": { + "type": "string", + "description": "The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is interpreted as a string representing an ISO 8601 duration with following format \"hh:mm:ss.fff\"." + }, + "HealthCheckWaitDuration": { + "type": "string", + "description": "The amount of time to wait after completing an upgrade domain before applying health policies. It is interpreted as a string representing an ISO 8601 duration with following format \"hh:mm:ss.fff\"." + }, + "ManagedIdentity": { + "type": "object", + "description": "Describes the managed identities for an Azure resource.", + "properties": { + "principalId": { + "type": "string", + "readOnly": true, + "description": "The principal id of the managed identity. This property will only be provided for a system assigned identity." + }, + "tenantId": { + "type": "string", + "readOnly": true, + "description": "The tenant id of the managed identity. This property will only be provided for a system assigned identity." + }, + "type": { + "$ref": "#/definitions/ManagedIdentityType" + }, + "userAssignedIdentities": { + "$ref": "#/definitions/UserAssignedIdentityMap" + } + } + }, + "ManagedIdentityType": { + "type": "string", + "description": "The type of managed identity for the resource.", + "enum": [ + "None", + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned" + ], + "x-ms-enum": { + "name": "ManagedIdentityType", + "modelAsString": false, + "values": [ + { + "value": "None", + "description": "Indicates that no identity is associated with the resource." + }, + { + "value": "SystemAssigned", + "description": "Indicates that system assigned identity is associated with the resource." + }, + { + "value": "UserAssigned", + "description": "Indicates that user assigned identity is associated with the resource." + }, + { + "value": "SystemAssigned, UserAssigned", + "description": "Indicates that both system assigned and user assigned identity are associated with the resource." + } + ] + } + }, + "MoveCost": { + "type": "string", + "description": "Specifies the move cost for the service.", + "enum": [ + "Zero", + "Low", + "Medium", + "High" + ], + "x-ms-enum": { + "name": "MoveCost", + "modelAsString": true, + "values": [ + { + "value": "Zero", + "description": "Zero move cost. This value is zero." + }, + { + "value": "Low", + "description": "Specifies the move cost of the service as Low. The value is 1." + }, + { + "value": "Medium", + "description": "Specifies the move cost of the service as Medium. The value is 2." + }, + { + "value": "High", + "description": "Specifies the move cost of the service as High. The value is 3." + } + ] + } + }, + "NamedPartitionScheme": { + "type": "object", + "description": "Describes the named partition scheme of the service.", + "allOf": [ + { + "$ref": "#/definitions/Partition" + }, + { + "type": "object", + "description": "NamedPartitionScheme" + } + ], + "x-ms-discriminator-value": "Named", + "required": [ + "names" + ], + "properties": { + "names": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array for the names of the partitions." + } + } + }, + "Partition": { + "type": "object", + "discriminator": "partitionScheme", + "description": "Describes how the service is partitioned.", + "required": [ + "partitionScheme" + ], + "properties": { + "partitionScheme": { + "$ref": "#/definitions/PartitionScheme", + "description": "Specifies how the service is partitioned." + } + } + }, + "PartitionInstanceCountScaleMechanism": { + "type": "object", + "description": "Represents a scaling mechanism for adding or removing instances of stateless service partition.", + "allOf": [ + { + "$ref": "#/definitions/ScalingMechanism" + }, + { + "type": "object", + "description": "PartitionInstanceCountScaleMechanism" + } + ], + "x-ms-discriminator-value": "ScalePartitionInstanceCount", + "required": [ + "minInstanceCount", + "maxInstanceCount", + "scaleIncrement" + ], + "properties": { + "minInstanceCount": { + "type": "integer", + "format": "int32", + "description": "Minimum number of instances of the partition." + }, + "maxInstanceCount": { + "type": "integer", + "format": "int32", + "description": "Maximum number of instances of the partition." + }, + "scaleIncrement": { + "type": "integer", + "format": "int32", + "description": "The number of instances to add or remove during a scaling operation." + } + } + }, + "PartitionScheme": { + "type": "string", + "description": "Enumerates the ways that a service can be partitioned.", + "enum": [ + "Singleton", + "UniformInt64Range", + "Named" + ], + "x-ms-enum": { + "name": "PartitionScheme", + "modelAsString": true, + "values": [ + { + "value": "Singleton", + "description": "Indicates that the partition is based on string names, and is a SingletonPartitionScheme object, The value is 0." + }, + { + "value": "UniformInt64Range", + "description": "Indicates that the partition is based on Int64 key ranges, and is a UniformInt64RangePartitionScheme object. The value is 1." + }, + { + "value": "Named", + "description": "Indicates that the partition is based on string names, and is a NamedPartitionScheme object. The value is 2." + } + ] + } + }, + "ProxyResource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Azure resource identifier.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Azure resource name.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Azure resource type.", + "readOnly": true + }, + "location": { + "type": "string", + "description": "Resource location depends on the parent resource.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Azure resource tags.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "systemData": { + "$ref": "#/definitions/SystemData" + } + }, + "description": "The resource model definition for proxy-only resource.", + "x-ms-azure-resource": true + }, + "RollingUpgradeMode": { + "type": "string", + "description": "The mode used to monitor health during a rolling upgrade. The values are Monitored, and UnmonitoredAuto.", + "enum": [ + "Monitored", + "UnmonitoredAuto" + ], + "x-ms-enum": { + "name": "RollingUpgradeMode", + "modelAsString": true, + "values": [ + { + "value": "Monitored", + "description": "The upgrade will stop after completing each upgrade domain and automatically monitor health before proceeding. The value is 0." + }, + { + "value": "UnmonitoredAuto", + "description": "The upgrade will proceed automatically without performing any health monitoring. The value is 1." + } + ] + } + }, + "RollingUpgradeMonitoringPolicy": { + "type": "object", + "description": "The policy used for monitoring the application upgrade", + "required": [ + "failureAction", + "healthCheckWaitDuration", + "healthCheckStableDuration", + "healthCheckRetryTimeout", + "upgradeTimeout", + "upgradeDomainTimeout" + ], + "properties": { + "failureAction": { + "type": "string", + "description": "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.", + "enum": [ + "Rollback", + "Manual" + ], + "x-ms-enum": { + "name": "FailureAction", + "modelAsString": true, + "values": [ + { + "value": "Rollback", + "description": "Indicates that a rollback of the upgrade will be performed by Service Fabric if the upgrade fails." + }, + { + "value": "Manual", + "description": "Indicates that a manual repair will need to be performed by the administrator if the upgrade fails. Service Fabric will not proceed to the next upgrade domain automatically." + } + ] + } + }, + "healthCheckWaitDuration": { + "$ref": "#/definitions/HealthCheckWaitDuration" + }, + "healthCheckStableDuration": { + "$ref": "#/definitions/HealthCheckStableDuration" + }, + "healthCheckRetryTimeout": { + "$ref": "#/definitions/HealthCheckRetryTimeout" + }, + "upgradeTimeout": { + "$ref": "#/definitions/UpgradeTimeout" + }, + "upgradeDomainTimeout": { + "$ref": "#/definitions/UpgradeDomainTimeout" + } + } + }, + "ScalingMechanism": { + "type": "object", + "discriminator": "kind", + "description": "Describes the mechanism for performing a scaling operation.", + "required": [ + "kind" + ], + "properties": { + "kind": { + "$ref": "#/definitions/ServiceScalingMechanismKind", + "description": "Specifies the mechanism associated with this scaling policy." + } + } + }, + "ScalingPolicy": { + "type": "object", + "description": "Specifies a metric to load balance a service during runtime.", + "required": [ + "scalingMechanism", + "scalingTrigger" + ], + "properties": { + "scalingMechanism": { + "$ref": "#/definitions/ScalingMechanism", + "description": "Specifies the mechanism associated with this scaling policy" + }, + "scalingTrigger": { + "$ref": "#/definitions/ScalingTrigger", + "description": "Specifies the trigger associated with this scaling policy." + } + } + }, + "ScalingPolicyList": { + "type": "array", + "items": { + "$ref": "#/definitions/ScalingPolicy" + }, + "description": "Scaling policies for this service." + }, + "ScalingTrigger": { + "type": "object", + "discriminator": "kind", + "description": "Describes the trigger for performing a scaling operation.", + "required": [ + "kind" + ], + "properties": { + "kind": { + "$ref": "#/definitions/ServiceScalingTriggerKind", + "description": "Specifies the trigger associated with this scaling policy." + } + } + }, + "ServiceCorrelation": { + "type": "object", + "description": "Creates a particular correlation between services.", + "required": [ + "scheme", + "serviceName" + ], + "properties": { + "scheme": { + "$ref": "#/definitions/ServiceCorrelationScheme", + "description": "The ServiceCorrelationScheme which describes the relationship between this service and the service specified via ServiceName." + }, + "serviceName": { + "$ref": "#/definitions/ServiceName", + "description": "The Arm Resource ID of the service that the correlation relationship is established with." + } + } + }, + "ServiceCorrelationScheme": { + "type": "string", + "description": "The service correlation scheme.", + "enum": [ + "AlignedAffinity", + "NonAlignedAffinity" + ], + "x-ms-enum": { + "name": "ServiceCorrelationScheme", + "modelAsString": true, + "values": [ + { + "value": "AlignedAffinity", + "description": "Aligned affinity ensures that the primaries of the partitions of the affinitized services are collocated on the same nodes. This is the default and is the same as selecting the Affinity scheme. The value is 0." + }, + { + "value": "NonAlignedAffinity", + "description": "Non-Aligned affinity guarantees that all replicas of each service will be placed on the same nodes. Unlike Aligned Affinity, this does not guarantee that replicas of particular role will be collocated. The value is 1." + } + ] + } + }, + "ServiceKind": { + "type": "string", + "description": "The kind of service (Stateless or Stateful).", + "enum": [ + "Stateless", + "Stateful" + ], + "x-ms-enum": { + "name": "ServiceKind", + "modelAsString": true, + "values": [ + { + "value": "Stateless", + "description": "Does not use Service Fabric to make its state highly available or reliable. The value is 0." + }, + { + "value": "Stateful", + "description": "Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 1." + } + ] + } + }, + "ServiceLoadMetric": { + "type": "object", + "description": "Specifies a metric to load balance a service during runtime.", + "required": [ + "name" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the metric. If the service chooses to report load during runtime, the load metric name should match the name that is specified in Name exactly. Note that metric names are case sensitive." + }, + "weight": { + "$ref": "#/definitions/ServiceLoadMetricWeight", + "description": "The service load metric relative weight, compared to other metrics configured for this service, as a number." + }, + "primaryDefaultLoad": { + "type": "integer", + "format": "int32", + "description": "Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Primary replica." + }, + "secondaryDefaultLoad": { + "type": "integer", + "format": "int32", + "description": "Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Secondary replica." + }, + "defaultLoad": { + "type": "integer", + "format": "int32", + "description": "Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric." + } + } + }, + "ServiceLoadMetricsList": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceLoadMetric" + }, + "description": "The service load metrics is given as an array of ServiceLoadMetric objects." + }, + "ServiceLoadMetricWeight": { + "type": "string", + "description": "Determines the metric weight relative to the other metrics that are configured for this service. During runtime, if two metrics end up in conflict, the Cluster Resource Manager prefers the metric with the higher weight.", + "enum": [ + "Zero", + "Low", + "Medium", + "High" + ], + "x-ms-enum": { + "name": "ServiceLoadMetricWeight", + "modelAsString": true, + "values": [ + { + "value": "Zero", + "description": "Disables resource balancing for this metric. This value is zero." + }, + { + "value": "Low", + "description": "Specifies the metric weight of the service load as Low. The value is 1." + }, + { + "value": "Medium", + "description": "Specifies the metric weight of the service load as Medium. The value is 2." + }, + { + "value": "High", + "description": "Specifies the metric weight of the service load as High. The value is 3." + } + ] + } + }, + "ServiceName": { + "type": "string", + "description": "The full ARM Resource ID describing the service resource", + "x-sf-clientlib": { + "typeName": "ServiceName" + } + }, + "ServicePlacementInvalidDomainPolicy": { + "type": "object", + "description": "Describes the policy to be used for placement of a Service Fabric service where a particular fault or upgrade domain should not be used for placement of the instances or replicas of that service.", + "allOf": [ + { + "$ref": "#/definitions/ServicePlacementPolicy" + }, + { + "type": "object", + "description": "ServicePlacementInvalidDomainPolicy" + } + ], + "x-ms-discriminator-value": "InvalidDomain", + "required": [ + "domainName" + ], + "properties": { + "domainName": { + "type": "string", + "description": "The name of the domain that should not be used for placement." + } + } + }, + "ServicePlacementNonPartiallyPlaceServicePolicy": { + "type": "object", + "description": "The name of the domain that should used for placement as per this policy.", + "allOf": [ + { + "$ref": "#/definitions/ServicePlacementPolicy" + }, + { + "type": "object", + "description": "ServicePlacementNonPartiallyPlaceServicePolicy" + } + ], + "x-ms-discriminator-value": "NonPartiallyPlaceService" + }, + "ServicePlacementPoliciesList": { + "type": "array", + "items": { + "$ref": "#/definitions/ServicePlacementPolicy" + }, + "description": "A list that describes the correlation of the service with other services." + }, + "ServicePlacementPolicy": { + "type": "object", + "discriminator": "type", + "description": "Describes the policy to be used for placement of a Service Fabric service.", + "required": [ + "type" + ], + "properties": { + "type": { + "$ref": "#/definitions/ServicePlacementPolicyType" + } + } + }, + "ServicePlacementPolicyType": { + "type": "string", + "description": "The type of placement policy for a service fabric service. Following are the possible values.", + "enum": [ + "InvalidDomain", + "RequiredDomain", + "PreferredPrimaryDomain", + "RequiredDomainDistribution", + "NonPartiallyPlaceService" + ], + "x-ms-enum": { + "name": "ServicePlacementPolicyType", + "modelAsString": true, + "values": [ + { + "value": "InvalidDomain", + "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementInvalidDomainPolicyDescription, which indicates that a particular fault or upgrade domain cannot be used for placement of this service. The value is 0." + }, + { + "value": "RequiredDomain", + "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementRequireDomainDistributionPolicyDescription indicating that the replicas of the service must be placed in a specific domain. The value is 1." + }, + { + "value": "PreferredPrimaryDomain", + "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementPreferPrimaryDomainPolicyDescription, which indicates that if possible the Primary replica for the partitions of the service should be located in a particular domain as an optimization. The value is 2." + }, + { + "value": "RequiredDomainDistribution", + "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementRequireDomainDistributionPolicyDescription, indicating that the system will disallow placement of any two replicas from the same partition in the same domain at any time. The value is 3." + }, + { + "value": "NonPartiallyPlaceService", + "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementNonPartiallyPlaceServicePolicyDescription, which indicates that if possible all replicas of a particular partition of the service should be placed atomically. The value is 4." + } + ] + } + }, + "ServicePlacementPreferPrimaryDomainPolicy": { + "type": "object", + "description": "Describes the policy to be used for placement of a Service Fabric service where the service's \nPrimary replicas should optimally be placed in a particular domain.\n\nThis placement policy is usually used with fault domains in scenarios where the Service Fabric\ncluster is geographically distributed in order to indicate that a service's primary replica should\nbe located in a particular fault domain, which in geo-distributed scenarios usually aligns with regional\nor datacenter boundaries. Note that since this is an optimization it is possible that the Primary replica\nmay not end up located in this domain due to failures, capacity limits, or other constraints.\n", + "allOf": [ + { + "$ref": "#/definitions/ServicePlacementPolicy" + }, + { + "type": "object", + "description": "ServicePlacementPreferPrimaryDomainPolicy" + } + ], + "x-ms-discriminator-value": "PreferredPrimaryDomain", + "required": [ + "domainName" + ], + "properties": { + "domainName": { + "type": "string", + "description": "The name of the domain that should used for placement as per this policy." + } + } + }, + "ServicePlacementRequiredDomainPolicy": { + "type": "object", + "description": "Describes the policy to be used for placement of a Service Fabric service where the instances or replicas of that service must be placed in a particular domain.", + "allOf": [ + { + "$ref": "#/definitions/ServicePlacementPolicy" + }, + { + "type": "object", + "description": "ServicePlacementRequiredDomainPolicy" + } + ], + "x-ms-discriminator-value": "RequiredDomain", + "required": [ + "domainName" + ], + "properties": { + "domainName": { + "type": "string", + "description": "The name of the domain that should used for placement as per this policy." + } + } + }, + "ServicePlacementRequireDomainDistributionPolicy": { + "type": "object", + "description": "Describes the policy to be used for placement of a Service Fabric service where two replicas\nfrom the same partition should never be placed in the same fault or upgrade domain.\n\nWhile this is not common it can expose the service to an increased risk of concurrent failures\ndue to unplanned outages or other cases of subsequent/concurrent failures. As an example, consider\na case where replicas are deployed across different data center, with one replica per location.\nIn the event that one of the datacenters goes offline, normally the replica that was placed in that\ndatacenter will be packed into one of the remaining datacenters. If this is not desirable then this\npolicy should be set.\n", + "allOf": [ + { + "$ref": "#/definitions/ServicePlacementPolicy" + }, + { + "type": "object", + "description": "ServicePlacementRequireDomainDistributionPolicy" + } + ], + "x-ms-discriminator-value": "RequiredDomainDistribution", + "required": [ + "domainName" + ], + "properties": { + "domainName": { + "type": "string", + "description": "The name of the domain that should used for placement as per this policy." + } + } + }, + "ServiceResource": { + "type": "object", + "description": "The service resource.", + "properties": { + "properties": { + "$ref": "#/definitions/ServiceResourceProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ] + }, + "ServiceResourceList": { + "type": "object", + "description": "The list of service resources.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceResource" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of service list results if there are any.", + "readOnly": true + } + } + }, + "ServiceResourceProperties": { + "type": "object", + "description": "The service resource properties.", + "allOf": [ + { + "$ref": "#/definitions/ServiceResourcePropertiesBase" + } + ], + "required": [ + "serviceKind", + "serviceTypeName", + "partitionDescription" + ], + "discriminator": "serviceKind", + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current deployment or provisioning state, which only appears in the response" + }, + "serviceKind": { + "$ref": "#/definitions/ServiceKind" + }, + "serviceTypeName": { + "type": "string", + "description": "The name of the service type" + }, + "partitionDescription": { + "$ref": "#/definitions/Partition" + }, + "servicePackageActivationMode": { + "type": "string", + "description": "The activation Mode of the service package", + "enum": [ + "SharedProcess", + "ExclusiveProcess" + ], + "x-ms-enum": { + "name": "ServicePackageActivationMode", + "modelAsString": true, + "values": [ + { + "value": "SharedProcess", + "description": "Indicates the application package activation mode will use shared process." + }, + { + "value": "ExclusiveProcess", + "description": "Indicates the application package activation mode will use exclusive process." + } + ] + } + } + } + }, + "ServiceResourcePropertiesBase": { + "type": "object", + "description": "The common service resource properties.", + "properties": { + "placementConstraints": { + "type": "string", + "description": "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)\"." + }, + "correlationScheme": { + "$ref": "#/definitions/CorrelationSchemeList" + }, + "serviceLoadMetrics": { + "$ref": "#/definitions/ServiceLoadMetricsList" + }, + "servicePlacementPolicies": { + "$ref": "#/definitions/ServicePlacementPoliciesList" + }, + "defaultMoveCost": { + "$ref": "#/definitions/MoveCost" + }, + "scalingPolicies": { + "$ref": "#/definitions/ScalingPolicyList" + } + } + }, + "ServiceScalingMechanismKind": { + "type": "string", + "description": "Enumerates the ways that a service can be partitioned.", + "enum": [ + "ScalePartitionInstanceCount", + "AddRemoveIncrementalNamedPartition" + ], + "x-ms-enum": { + "name": "ServiceScalingMechanismKind", + "modelAsString": true, + "values": [ + { + "value": "ScalePartitionInstanceCount", + "description": "Represents a scaling mechanism for adding or removing instances of stateless service partition. The value is 0." + }, + { + "value": "AddRemoveIncrementalNamedPartition", + "description": "Represents a scaling mechanism for adding or removing named partitions of a stateless service. The value is 1." + } + ] + } + }, + "ServiceScalingTriggerKind": { + "type": "string", + "description": "Enumerates the ways that a service can be partitioned.", + "enum": [ + "AveragePartitionLoad", + "AverageServiceLoad" + ], + "x-ms-enum": { + "name": "ServiceScalingTriggerKind", + "modelAsString": true, + "values": [ + { + "value": "AveragePartitionLoad", + "description": "Represents a scaling trigger related to an average load of a metric/resource of a partition. The value is 0." + }, + { + "value": "AverageServiceLoad", + "description": "Represents a scaling policy related to an average load of a metric/resource of a service. The value is 1." + } + ] + } + }, + "ServiceTypeHealthPolicy": { + "type": "object", + "description": "Represents the health policy used to evaluate the health of services belonging to a service type.\n", + "required": [ + "maxPercentUnhealthyServices", + "maxPercentUnhealthyPartitionsPerService", + "maxPercentUnhealthyReplicasPerPartition" + ], + "properties": { + "maxPercentUnhealthyServices": { + "type": "integer", + "format": "int32", + "description": "The maximum allowed percentage of unhealthy services.\n\nThe percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error.\nIf the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning.\nThis 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.\nThe computation rounds up to tolerate one failure on small numbers of services.\n", + "minimum": 0, + "maximum": 100 + }, + "maxPercentUnhealthyPartitionsPerService": { + "type": "integer", + "format": "int32", + "description": "The maximum allowed percentage of unhealthy partitions per service.\n\nThe percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error.\nIf the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning.\nThe percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service.\nThe computation rounds up to tolerate one failure on small numbers of partitions.\n", + "minimum": 0, + "maximum": 100 + }, + "maxPercentUnhealthyReplicasPerPartition": { + "type": "integer", + "format": "int32", + "description": "The maximum allowed percentage of unhealthy replicas per partition.\n\nThe percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error.\nIf the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning.\nThe percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition.\nThe computation rounds up to tolerate one failure on small numbers of replicas.\n", + "minimum": 0, + "maximum": 100 + } + } + }, + "ServiceTypeHealthPolicyMap": { + "type": "object", + "description": "Defines a ServiceTypeHealthPolicy per service type name.\n\nThe entries in the map replace the default service type health policy for each specified service type.\nFor example, in an application that contains both a stateless gateway service type and a stateful engine service type, the health policies for the stateless and stateful services can be configured differently.\nWith policy per service type, there's more granular control of the health of the service.\n\nIf no policy is specified for a service type name, the DefaultServiceTypeHealthPolicy is used for evaluation.\n", + "additionalProperties": { + "$ref": "#/definitions/ServiceTypeHealthPolicy" + } + }, + "ServiceUpdateParameters": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "description": "Service update parameters", + "additionalProperties": { + "type": "string" + } + } + }, + "description": "Service update request" + }, + "SingletonPartitionScheme": { + "type": "object", + "description": "Describes the partition scheme of a singleton-partitioned, or non-partitioned service.", + "allOf": [ + { + "$ref": "#/definitions/Partition" + }, + { + "type": "object", + "description": "SingletonPartitionScheme" + } + ], + "x-ms-discriminator-value": "Singleton" + }, + "StatefulServiceProperties": { + "type": "object", + "description": "The properties of a stateful service resource.", + "allOf": [ + { + "$ref": "#/definitions/ServiceResourceProperties" + } + ], + "x-ms-discriminator-value": "Stateful", + "properties": { + "hasPersistedState": { + "type": "boolean", + "description": "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." + }, + "targetReplicaSetSize": { + "type": "integer", + "format": "int32", + "minimum": 1, + "description": "The target replica set size as a number." + }, + "minReplicaSetSize": { + "type": "integer", + "format": "int32", + "minimum": 1, + "description": "The minimum replica set size as a number." + }, + "replicaRestartWaitDuration": { + "type": "string", + "description": "The duration between when a replica goes down and when a new replica is created, represented in ISO 8601 format \"hh:mm:ss\"." + }, + "quorumLossWaitDuration": { + "type": "string", + "description": "The maximum duration for which a partition is allowed to be in a state of quorum loss, represented in ISO 8601 format \"hh:mm:ss\"." + }, + "standByReplicaKeepDuration": { + "type": "string", + "description": "The definition on how long StandBy replicas should be maintained before being removed, represented in ISO 8601 format \"hh:mm:ss\"." + }, + "servicePlacementTimeLimit": { + "type": "string", + "description": "The duration for which replicas can stay InBuild before reporting that build is stuck, represented in ISO 8601 format \"hh:mm:ss\"." + } + } + }, + "StatelessServiceProperties": { + "type": "object", + "description": "The properties of a stateless service resource.", + "allOf": [ + { + "$ref": "#/definitions/ServiceResourceProperties" + } + ], + "x-ms-discriminator-value": "Stateless", + "required": [ + "instanceCount" + ], + "properties": { + "instanceCount": { + "type": "integer", + "format": "int32", + "minimum": -1, + "description": "The instance count." + }, + "minInstanceCount": { + "type": "integer", + "format": "int32", + "description": "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." + }, + "minInstancePercentage": { + "type": "integer", + "format": "int32", + "description": "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." + } + } + }, + "UniformInt64RangePartitionScheme": { + "type": "object", + "description": "Describes a partitioning scheme where an integer range is allocated evenly across a number of partitions.", + "allOf": [ + { + "$ref": "#/definitions/Partition" + }, + { + "type": "object", + "description": "UniformInt64RangePartitionScheme" + } + ], + "x-ms-discriminator-value": "UniformInt64Range", + "required": [ + "count", + "lowKey", + "highKey" + ], + "properties": { + "count": { + "type": "integer", + "format": "int32", + "description": "The number of partitions." + }, + "lowKey": { + "type": "integer", + "format": "int64", + "description": "The lower bound of the partition key range that\nshould be split between the partition ‘Count’\n" + }, + "highKey": { + "type": "integer", + "format": "int64", + "description": "The upper bound of the partition key range that\nshould be split between the partition ‘Count’\n" + } + } + }, + "UpgradeDomainTimeout": { + "type": "string", + "description": "The amount of time each upgrade domain has to complete before FailureAction is executed. Cannot be larger than 12 hours. It is interpreted as a string representing an ISO 8601 duration with following format \"hh:mm:ss.fff\"." + }, + "UpgradeTimeout": { + "type": "string", + "description": "The amount of time the overall upgrade has to complete before FailureAction is executed. Cannot be larger than 12 hours. It is interpreted as a string representing an ISO 8601 duration with following format \"hh:mm:ss.fff\"." + }, + "UserAssignedIdentity": { + "type": "object", + "properties": { + "principalId": { + "type": "string", + "readOnly": true, + "description": "The principal id of user assigned identity." + }, + "clientId": { + "type": "string", + "readOnly": true, + "description": "The client id of user assigned identity." + } + } + }, + "UserAssignedIdentityMap": { + "type": "object", + "description": "The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form:\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.\n", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedIdentity" + } + }, + "AvailableOperationDisplay": { + "type": "object", + "properties": { + "provider": { + "type": "string", + "description": "The name of the provider." + }, + "resource": { + "type": "string", + "description": "The resource on which the operation is performed" + }, + "operation": { + "type": "string", + "description": "The operation that can be performed." + }, + "description": { + "type": "string", + "description": "Operation description" + } + }, + "description": "Operation supported by the Service Fabric resource provider" + }, + "ErrorModel": { + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/ErrorModelError", + "description": "The error details." + } + }, + "description": "The structure of the error." + }, + "ErrorModelError": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The error code." + }, + "message": { + "type": "string", + "description": "The error message." + } + }, + "description": "The error details." + }, + "OperationResult": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the operation." + }, + "isDataAction": { + "type": "boolean", + "description": "Indicates whether the operation is a data action" + }, + "display": { + "$ref": "#/definitions/AvailableOperationDisplay", + "description": "The object that represents the operation." + }, + "origin": { + "type": "string", + "description": "Origin result" + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "Available operation list result" + }, + "SystemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "type": "object", + "readOnly": true, + "properties": { + "createdBy": { + "type": "string", + "description": "The identity that created the resource." + }, + "createdByType": { + "type": "string", + "description": "The type of identity that created the resource." + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource creation (UTC)." + }, + "lastModifiedBy": { + "type": "string", + "description": "The identity that last modified the resource." + }, + "lastModifiedByType": { + "type": "string", + "description": "The type of identity that last modified the resource." + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource last modification (UTC)." + } + } + } + }, + "parameters": { + "api-version": { + "name": "api-version", + "in": "query", + "description": "The version of the Service Fabric resource provider API. This is a required parameter and it's value must be \"2021-11-01-preview\" for this specification.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "applicationName": { + "name": "applicationName", + "in": "path", + "description": "The name of the application resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "applicationTypeName": { + "name": "applicationTypeName", + "in": "path", + "description": "The name of the application type name resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "clusterNameParameter": { + "name": "clusterName", + "in": "path", + "description": "The name of the cluster resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "serviceName": { + "name": "serviceName", + "in": "path", + "description": "The name of the service resource in the format of {applicationName}~{serviceName}.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "subscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The customer subscription identifier.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "version": { + "name": "version", + "in": "path", + "description": "The application type version.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/managedcluster.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/managedcluster.json new file mode 100644 index 000000000000..59f81cd3793e --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/managedcluster.json @@ -0,0 +1,1713 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceFabricManagementClient", + "description": "Azure Service Fabric Resource Provider API Client", + "version": "2021-11-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "type": "oauth2" + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "paths": { + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters": { + "get": { + "operationId": "ManagedClusters_ListByResourceGroup", + "summary": "Gets the list of Service Fabric cluster resources created in the specified resource group.", + "description": "Gets all Service Fabric cluster resources created or in the process of being created in the resource group.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "tags": [ + "ManagedCluster" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List cluster by resource group": { + "$ref": "./examples/ManagedClusterListByResourceGroupOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ManagedClusterListResult" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/managedClusters": { + "get": { + "operationId": "ManagedClusters_ListBySubscription", + "summary": "Gets the list of Service Fabric cluster resources created in the specified subscription.", + "description": "Gets all Service Fabric cluster resources created or in the process of being created in the subscription.", + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "tags": [ + "ManagedCluster" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List managed clusters": { + "$ref": "./examples/ManagedClusterListBySubscriptionOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ManagedClusterListResult" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}": { + "get": { + "tags": [ + "ManagedCluster" + ], + "operationId": "ManagedClusters_Get", + "summary": "Gets a Service Fabric managed cluster resource.", + "description": "Get a Service Fabric managed cluster resource created or in the process of being created in the specified resource group.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "x-ms-examples": { + "Get a cluster": { + "$ref": "./examples/ManagedClusterGetOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "put": { + "tags": [ + "ManagedCluster" + ], + "operationId": "ManagedClusters_CreateOrUpdate", + "summary": "Creates or updates a Service Fabric managed cluster resource.", + "description": "Create or update a Service Fabric managed cluster resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "parameters", + "in": "body", + "description": "The cluster resource.", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedCluster" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Put a cluster with minimum parameters": { + "$ref": "./examples/ManagedClusterPutOperation_example_min.json" + }, + "Put a cluster with maximum parameters": { + "$ref": "./examples/ManagedClusterPutOperation_example_max.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "202": { + "description": "The request was accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "patch": { + "tags": [ + "ManagedCluster" + ], + "operationId": "ManagedClusters_Update", + "summary": "Updates the tags of of a Service Fabric managed cluster resource.", + "description": "Update the tags of of a Service Fabric managed cluster resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "parameters", + "in": "body", + "description": "The managed cluster resource updated tags.", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedClusterUpdateParameters" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Patch a managed cluster": { + "$ref": "./examples/ManagedClusterPatchOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "tags": [ + "ManagedCluster" + ], + "operationId": "ManagedClusters_Delete", + "summary": "Deletes a Service Fabric managed cluster resource.", + "description": "Delete a Service Fabric managed cluster resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "x-ms-examples": { + "Delete a cluster": { + "$ref": "./examples/ManagedClusterDeleteOperation_example.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously." + }, + "204": { + "description": "The resource was not found." + }, + "200": { + "description": "The operation completed successfully." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/managedClusterVersions/{clusterVersion}": { + "get": { + "operationId": "ManagedClusterVersion_Get", + "summary": "Gets information about a Service Fabric managed cluster code version available in the specified location.", + "description": "Gets information about an available Service Fabric managed cluster code version.", + "parameters": [ + { + "$ref": "#/parameters/location" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/clusterVersion" + } + ], + "x-ms-examples": { + "Get cluster version": { + "$ref": "./examples/ManagedClusterVersionGet_example.json" + } + }, + "tags": [ + "ManagedClusterVersion" + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ManagedClusterCodeVersionResult" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/environments/{environment}/managedClusterVersions/{clusterVersion}": { + "get": { + "operationId": "ManagedClusterVersion_GetByEnvironment", + "summary": "Gets information about a Service Fabric cluster code version available for the specified environment.", + "description": "Gets information about an available Service Fabric cluster code version by environment.", + "parameters": [ + { + "$ref": "#/parameters/location" + }, + { + "$ref": "#/parameters/environment" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/clusterVersion" + } + ], + "x-ms-examples": { + "Get cluster version by environment": { + "$ref": "./examples/ManagedClusterVersionGetByEnvironment_example.json" + } + }, + "tags": [ + "ManagedClusterVersion" + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ManagedClusterCodeVersionResult" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/managedClusterVersions": { + "get": { + "operationId": "ManagedClusterVersion_List", + "summary": "Gets the list of Service Fabric cluster code versions available for the specified location.", + "description": "Gets all available code versions for Service Fabric cluster resources by location.", + "parameters": [ + { + "$ref": "#/parameters/location" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "x-ms-examples": { + "List cluster versions": { + "$ref": "./examples/ManagedClusterVersionList_example.json" + } + }, + "tags": [ + "ManagedClusterVersion" + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ManagedClusterCodeVersionListResult" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/environments/{environment}/managedClusterVersions": { + "get": { + "operationId": "ManagedClusterVersion_ListByEnvironment", + "summary": "Gets the list of Service Fabric cluster code versions available for the specified environment.", + "description": "Gets all available code versions for Service Fabric cluster resources by environment.", + "parameters": [ + { + "$ref": "#/parameters/location" + }, + { + "$ref": "#/parameters/environment" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "x-ms-examples": { + "List cluster versions by environment": { + "$ref": "./examples/ManagedClusterVersionListByEnvironment.json" + } + }, + "tags": [ + "ManagedClusterVersion" + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ManagedClusterCodeVersionListResult" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/managedUnsupportedVMSizes": { + "get": { + "tags": [ + "managedVMSizes" + ], + "summary": "Get the lists of unsupported vm sizes for Service Fabric Managed Clusters.", + "description": "Get the lists of unsupported vm sizes for Service Fabric Managed Clusters.", + "operationId": "managedUnsupportedVMSizes_List", + "parameters": [ + { + "$ref": "#/parameters/location" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "x-ms-examples": { + "List unsupported vm sizes": { + "$ref": "./examples/managedUnsupportedVMSizesList_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ManagedVMSizesResult" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/managedUnsupportedVMSizes/{vmSize}": { + "get": { + "tags": [ + "managedVMSizes" + ], + "summary": "Get unsupported vm size for Service Fabric Managed Clusters.", + "description": "Get unsupported vm size for Service Fabric Managed Clusters.", + "operationId": "managedUnsupportedVMSizes_Get", + "parameters": [ + { + "$ref": "#/parameters/location" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/vmSize" + } + ], + "x-ms-examples": { + "Get unsupported vm sizes": { + "$ref": "./examples/managedUnsupportedVMSizesGet_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ManagedVMSize" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/providers/Microsoft.ServiceFabric/operations": { + "get": { + "tags": [ + "Operations" + ], + "summary": "Lists all of the available Service Fabric resource provider API operations.", + "description": "Get the list of available Service Fabric resource provider API operations.", + "operationId": "Operations_List", + "parameters": [ + { + "name": "api-version", + "in": "query", + "description": "The version of the Service Fabric resource provider API", + "required": true, + "type": "string" + } + ], + "x-ms-examples": { + "List available operations": { + "$ref": "./examples/Operations_example.json" + } + }, + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ManagedClusterAddOnFeature": { + "type": "string", + "description": "Available cluster add-on features", + "enum": [ + "DnsService", + "BackupRestoreService", + "ResourceMonitorService" + ] + }, + "ApplicationTypeVersionsCleanupPolicy": { + "type": "object", + "required": [ + "maxUnusedVersionsToKeep" + ], + "properties": { + "maxUnusedVersionsToKeep": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "Number of unused versions per application type to keep." + } + }, + "description": "The policy used to clean up unused versions. When the policy is not specified explicitly, the default unused application versions to keep will be 3." + }, + "AzureActiveDirectory": { + "type": "object", + "properties": { + "tenantId": { + "type": "string", + "description": "Azure active directory tenant id." + }, + "clusterApplication": { + "type": "string", + "description": "Azure active directory cluster application id." + }, + "clientApplication": { + "type": "string", + "description": "Azure active directory client application id." + } + }, + "description": "The settings to enable AAD authentication on the cluster." + }, + "ClientCertificate": { + "type": "object", + "required": [ + "isAdmin" + ], + "properties": { + "isAdmin": { + "type": "boolean", + "description": "Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster." + }, + "thumbprint": { + "type": "string", + "description": "Certificate thumbprint." + }, + "commonName": { + "type": "string", + "description": "Certificate common name." + }, + "issuerThumbprint": { + "type": "string", + "description": "Issuer thumbprint for the certificate. Only used together with CommonName." + } + }, + "description": "Client certificate definition." + }, + "ClusterState": { + "type": "string", + "description": "The current state of the cluster.\n", + "enum": [ + "WaitingForNodes", + "Deploying", + "BaselineUpgrade", + "Upgrading", + "UpgradeFailed", + "Ready" + ], + "x-ms-enum": { + "name": "ClusterState", + "modelAsString": true, + "values": [ + { + "value": "WaitingForNodes", + "description": "Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it." + }, + { + "value": "Deploying", + "description": "Indicates that the Service Fabric runtime is being installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up." + }, + { + "value": "BaselineUpgrade", + "description": "Indicates that the cluster is upgrading to establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time." + }, + { + "value": "Upgrading", + "description": "Indicates that the cluster is being upgraded with the user provided configuration." + }, + { + "value": "UpgradeFailed", + "description": "Indicates that the last upgrade for the cluster has failed." + }, + { + "value": "Ready", + "description": "Indicates that the cluster is in a stable state." + } + ] + } + }, + "ClusterUpgradeCadence": { + "type": "string", + "enum": [ + "Wave0", + "Wave1", + "Wave2" + ], + "x-ms-enum": { + "name": "clusterUpgradeCadence", + "modelAsString": true, + "values": [ + { + "value": "Wave0", + "description": "Cluster upgrade starts immediately after a new version is rolled out. Recommended for Test/Dev clusters." + }, + { + "value": "Wave1", + "description": "Cluster upgrade starts 7 days after a new version is rolled out. Recommended for Pre-prod clusters." + }, + { + "value": "Wave2", + "description": "Cluster upgrade starts 14 days after a new version is rolled out. Recommended for Production clusters." + } + ] + }, + "description": "Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0." + }, + "ClusterUpgradeMode": { + "type": "string", + "description": "The upgrade mode of the cluster when new Service Fabric runtime version is available.\n", + "enum": [ + "Automatic", + "Manual" + ], + "default": "Automatic", + "x-ms-enum": { + "name": "ClusterUpgradeMode", + "modelAsString": true, + "values": [ + { + "value": "Automatic", + "description": "The cluster will be automatically upgraded to the latest Service Fabric runtime version, **clusterUpgradeCadence** will determine when the upgrade starts after the new version becomes available." + }, + { + "value": "Manual", + "description": "The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource." + } + ] + } + }, + "IPTag": { + "type": "object", + "required": [ + "ipTagType", + "tag" + ], + "properties": { + "ipTagType": { + "type": "string", + "description": "The IP tag type." + }, + "tag": { + "type": "string", + "description": "The value of the IP tag." + } + }, + "description": "IPTag associated with the object." + }, + "LoadBalancingRule": { + "type": "object", + "required": [ + "frontendPort", + "backendPort", + "protocol", + "probeProtocol" + ], + "properties": { + "frontendPort": { + "type": "integer", + "format": "int32", + "description": "The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 1 and 65534.", + "minimum": 1, + "maximum": 65534 + }, + "backendPort": { + "type": "integer", + "format": "int32", + "description": "The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.", + "minimum": 1, + "maximum": 65534 + }, + "protocol": { + "type": "string", + "description": "The reference to the transport protocol used by the load balancing rule.", + "enum": [ + "tcp", + "udp" + ], + "x-ms-enum": { + "name": "protocol", + "modelAsString": true + } + }, + "probePort": { + "type": "integer", + "format": "int32", + "description": "The prob port used by the load balancing rule. Acceptable values are between 1 and 65535.", + "minimum": 1, + "maximum": 65534 + }, + "probeProtocol": { + "type": "string", + "description": "the reference to the load balancer probe used by the load balancing rule.", + "enum": [ + "tcp", + "http", + "https" + ], + "x-ms-enum": { + "name": "probeProtocol", + "modelAsString": true + } + }, + "probeRequestPath": { + "type": "string", + "description": "The probe request path. Only supported for HTTP/HTTPS probes." + } + }, + "description": "Describes a load balancing rule." + }, + "ManagedCluster": { + "type": "object", + "description": "The manged cluster resource\n", + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "type": "object" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ManagedClusterProperties", + "description": "The managed cluster resource properties" + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "The sku of the managed cluster" + } + } + }, + "ManagedClusterCodeVersionListResult": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterCodeVersionResult" + }, + "description": "The list results of the Service Fabric runtime versions." + }, + "ManagedClusterCodeVersionResult": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The identification of the result" + }, + "name": { + "type": "string", + "description": "The name of the result" + }, + "type": { + "type": "string", + "description": "The result resource type" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ManagedClusterVersionDetails" + } + }, + "description": "The result of the Service Fabric runtime versions" + }, + "ManagedClusterListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "Managed Cluster list results" + }, + "ManagedClusterProperties": { + "type": "object", + "required": [ + "dnsName", + "adminUserName" + ], + "properties": { + "dnsName": { + "type": "string", + "description": "The cluster dns name." + }, + "fqdn": { + "type": "string", + "description": "The fully qualified domain name associated with the public load balancer of the cluster.", + "readOnly": true + }, + "ipv4Address": { + "type": "string", + "description": "The IPv4 address associated with the public load balancer of the cluster.", + "readOnly": true + }, + "clusterId": { + "type": "string", + "description": "A service generated unique identifier for the cluster resource.", + "readOnly": true + }, + "clusterState": { + "readOnly": true, + "$ref": "#/definitions/ClusterState", + "description": "The current state of the cluster." + }, + "clusterCertificateThumbprints": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of thumbprints of the cluster certificates.", + "readOnly": true + }, + "clientConnectionPort": { + "type": "integer", + "format": "int32", + "description": "The port used for client connections to the cluster.", + "default": 19000 + }, + "httpGatewayConnectionPort": { + "type": "integer", + "format": "int32", + "description": "The port used for HTTP connections to the cluster.", + "default": 19080 + }, + "adminUserName": { + "type": "string", + "description": "VM admin user name." + }, + "adminPassword": { + "type": "string", + "x-ms-secret": true, + "format": "password", + "description": "VM admin user password." + }, + "loadBalancingRules": { + "type": "array", + "items": { + "$ref": "#/definitions/LoadBalancingRule" + }, + "description": "Load balancing rules that are applied to the public load balancer of the cluster." + }, + "allowRdpAccess": { + "type": "boolean", + "description": "Setting this to true enables RDP access to the VM. The default NSG rule opens RDP port to Internet which can be overridden with custom Network Security Rules. The default value for this setting is false." + }, + "networkSecurityRules": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkSecurityRule" + }, + "description": "Custom Network Security Rules that are applied to the Virtual Network of the cluster." + }, + "clients": { + "type": "array", + "items": { + "$ref": "#/definitions/ClientCertificate" + }, + "description": "Client certificates that are allowed to manage the cluster." + }, + "azureActiveDirectory": { + "$ref": "#/definitions/AzureActiveDirectory", + "description": "The AAD authentication settings of the cluster." + }, + "fabricSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/SettingsSectionDescription" + }, + "description": "The list of custom fabric settings to configure the cluster." + }, + "provisioningState": { + "$ref": "#/definitions/ManagedResourceProvisioningState", + "readOnly": true, + "description": "The provisioning state of the managed cluster resource." + }, + "clusterCodeVersion": { + "type": "string", + "description": "The Service Fabric runtime version of the cluster. This property is required when **clusterUpgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](./ClusterVersion.md). To get the list of available version for existing clusters use **availableClusterVersions**." + }, + "clusterUpgradeMode": { + "$ref": "#/definitions/ClusterUpgradeMode" + }, + "clusterUpgradeCadence": { + "$ref": "#/definitions/ClusterUpgradeCadence", + "description": "Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when **clusterUpgradeMode** is set to 'Automatic'." + }, + "addonFeatures": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterAddOnFeature" + }, + "description": "List of add-on features to enable on the cluster." + }, + "enableAutoOSUpgrade": { + "type": "boolean", + "description": "Setting this to true enables automatic OS upgrade for the node types that are created using any platform OS image with version 'latest'. The default value for this setting is false." + }, + "zonalResiliency": { + "type": "boolean", + "description": "Indicates if the cluster has zone resiliency.", + "default": false + }, + "applicationTypeVersionsCleanupPolicy": { + "$ref": "#/definitions/ApplicationTypeVersionsCleanupPolicy", + "description": "The policy used to clean up unused versions." + }, + "enableIpv6": { + "type": "boolean", + "description": "Setting this to true creates IPv6 address space for the default VNet used by the cluster. This setting cannot be changed once the cluster is created. The default value for this setting is false." + }, + "subnetId": { + "type": "string", + "description": "If specified, the node types for the cluster are created in this subnet instead of the default VNet. The **networkSecurityRules** specified for the cluster are also applied to this subnet. This setting cannot be changed once the cluster is created." + }, + "ipTags": { + "type": "array", + "items": { + "$ref": "#/definitions/IPTag" + }, + "description": "The list of IP tags associated with the default public IP address of the cluster." + }, + "ipv6Address": { + "type": "string", + "description": "IPv6 address for the cluster if IPv6 is enabled.", + "readOnly": true + }, + "enableServicePublicIP": { + "type": "boolean", + "description": "Setting this to true will link the IPv4 address as the ServicePublicIP of the IPv6 address. It can only be set to True if IPv6 is enabled on the cluster." + }, + "auxiliarySubnets": { + "type": "array", + "items": { + "$ref": "#/definitions/Subnet" + }, + "description": "Auxiliary subnets for the cluster." + }, + "serviceEndpoints": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceEndpoint" + }, + "description": "Service endpoints for subnets in the cluster." + } + }, + "description": "Describes the managed cluster resource properties." + }, + "ManagedClusterUpdateParameters": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "description": "Managed cluster update parameters", + "additionalProperties": { + "type": "string" + } + } + }, + "description": "Managed cluster update request" + }, + "ManagedClusterVersionDetails": { + "type": "object", + "properties": { + "clusterCodeVersion": { + "type": "string", + "description": "The Service Fabric runtime version of the cluster." + }, + "supportExpiryUtc": { + "type": "string", + "description": "The date of expiry of support of the version." + }, + "osType": { + "$ref": "#/definitions/OsType" + } + }, + "description": "The detail of the Service Fabric runtime version result" + }, + "ManagedVMSize": { + "type": "object", + "properties": { + "properties": { + "description": "VM Size properties.", + "$ref": "#/definitions/VMSize", + "readOnly": true + }, + "id": { + "type": "string", + "description": "VM Size id.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "VM Size name.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "VM Size type.", + "readOnly": true + } + }, + "description": "Describes a VM Sizes." + }, + "ManagedVMSizesResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "List of Managed VM Sizes for Service Fabric Managed Clusters.", + "items": { + "$ref": "#/definitions/ManagedVMSize" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of Managed VM Sizes if there are any.", + "readOnly": true + } + }, + "description": "Describes the result of the request to list Managed VM Sizes for Service Fabric Managed Clusters." + }, + "OsType": { + "type": "string", + "description": "Cluster operating system, the default will be Windows", + "enum": [ + "Windows" + ] + }, + "ServiceEndpoint": { + "type": "object", + "required": [ + "service" + ], + "properties": { + "service": { + "type": "string", + "description": "The type of the endpoint service." + }, + "locations": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of locations." + } + }, + "description": "The service endpoint properties." + }, + "Sku": { + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "$ref": "#/definitions/SkuName", + "description": "Sku Name." + } + }, + "description": "Service Fabric managed cluster Sku definition" + }, + "SkuName": { + "type": "string", + "description": "Sku Name.", + "enum": [ + "Basic", + "Standard" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true, + "values": [ + { + "value": "Basic", + "description": "Basic requires a minimum of 3 nodes and allows only 1 node type." + }, + { + "value": "Standard", + "description": "Requires a minimum of 5 nodes and allows 1 or more node type." + } + ] + } + }, + "Subnet": { + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "type": "string", + "description": "Subnet name." + }, + "enableIpv6": { + "type": "boolean", + "description": "Indicates wether to enable Ipv6 or not. If not provided, it will take the same configuration as the cluster." + }, + "privateEndpointNetworkPolicies": { + "type": "string", + "description": "Enable or Disable apply network policies on private end point in the subnet.", + "enum": [ + "enabled", + "disabled" + ], + "x-ms-enum": { + "name": "privateEndpointNetworkPolicies", + "modelAsString": true + } + }, + "privateLinkServiceNetworkPolicies": { + "type": "string", + "description": "Enable or Disable apply network policies on private link service in the subnet.", + "enum": [ + "enabled", + "disabled" + ], + "x-ms-enum": { + "name": "privateLinkServiceNetworkPolicies", + "modelAsString": true + } + }, + "networkSecurityGroupId": { + "type": "string", + "description": "Full resource id for the network security group." + } + }, + "description": "Describes a Subnet." + }, + "VMSize": { + "type": "object", + "properties": { + "size": { + "type": "string", + "description": "VM Size name.", + "readOnly": true + } + }, + "description": "VM Sizes properties." + }, + "AvailableOperationDisplay": { + "type": "object", + "properties": { + "provider": { + "type": "string", + "description": "The name of the provider." + }, + "resource": { + "type": "string", + "description": "The resource on which the operation is performed" + }, + "operation": { + "type": "string", + "description": "The operation that can be performed." + }, + "description": { + "type": "string", + "description": "Operation description" + } + }, + "description": "Operation supported by the Service Fabric resource provider" + }, + "ErrorModel": { + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/ErrorModelError", + "description": "The error details." + } + }, + "description": "The structure of the error." + }, + "ErrorModelError": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The error code." + }, + "message": { + "type": "string", + "description": "The error message." + } + }, + "description": "The error details." + }, + "ManagedResourceProvisioningState": { + "type": "string", + "description": "The provisioning state of the managed resource.", + "enum": [ + "None", + "Creating", + "Created", + "Updating", + "Succeeded", + "Failed", + "Canceled", + "Deleting", + "Deleted", + "Other" + ], + "x-ms-enum": { + "name": "ManagedResourceProvisioningState", + "modelAsString": true + } + }, + "NetworkSecurityRule": { + "type": "object", + "required": [ + "name", + "protocol", + "access", + "priority", + "direction" + ], + "properties": { + "name": { + "type": "string", + "description": "Network security rule name." + }, + "description": { + "type": "string", + "description": "Network security rule description." + }, + "protocol": { + "type": "string", + "description": "Network protocol this rule applies to.", + "enum": [ + "http", + "https", + "tcp", + "udp", + "icmp", + "ah", + "esp" + ], + "x-ms-enum": { + "name": "nsgProtocol", + "modelAsString": true + } + }, + "sourceAddressPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The CIDR or source IP ranges." + }, + "destinationAddressPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The destination address prefixes. CIDR or destination IP ranges." + }, + "sourcePortRanges": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The source port ranges." + }, + "destinationPortRanges": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The destination port ranges." + }, + "sourceAddressPrefix": { + "type": "string", + "description": "The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from." + }, + "destinationAddressPrefix": { + "type": "string", + "description": "The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used." + }, + "sourcePortRange": { + "type": "string", + "description": "The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports." + }, + "destinationPortRange": { + "type": "string", + "description": "he destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports." + }, + "access": { + "type": "string", + "description": "The network traffic is allowed or denied.", + "enum": [ + "allow", + "deny" + ], + "x-ms-enum": { + "name": "access", + "modelAsString": true + } + }, + "priority": { + "type": "integer", + "format": "int32", + "description": "The priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.", + "minimum": 1000, + "maximum": 3000 + }, + "direction": { + "type": "string", + "description": "Network security rule direction.", + "enum": [ + "inbound", + "outbound" + ], + "x-ms-enum": { + "name": "direction", + "modelAsString": true + } + } + }, + "description": "Describes a network security rule." + }, + "OperationListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "List of operations supported by the Service Fabric resource provider.", + "items": { + "$ref": "#/definitions/OperationResult" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any.", + "readOnly": true + } + }, + "description": "Describes the result of the request to list Service Fabric resource provider operations." + }, + "OperationResult": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the operation." + }, + "isDataAction": { + "type": "boolean", + "description": "Indicates whether the operation is a data action" + }, + "display": { + "$ref": "#/definitions/AvailableOperationDisplay", + "description": "The object that represents the operation." + }, + "origin": { + "type": "string", + "description": "Origin result" + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "Available operation list result" + }, + "Resource": { + "type": "object", + "required": [ + "location" + ], + "properties": { + "id": { + "type": "string", + "description": "Azure resource identifier.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Azure resource name.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Azure resource type.", + "readOnly": true + }, + "location": { + "type": "string", + "description": "Azure resource location.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "tags": { + "type": "object", + "description": "Azure resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "etag": { + "type": "string", + "description": "Azure resource etag.", + "readOnly": true + }, + "systemData": { + "$ref": "#/definitions/SystemData" + } + }, + "description": "The resource model definition.", + "x-ms-azure-resource": true + }, + "SettingsParameterDescription": { + "type": "object", + "required": [ + "name", + "value" + ], + "properties": { + "name": { + "type": "string", + "description": "The parameter name of fabric setting." + }, + "value": { + "type": "string", + "description": "The parameter value of fabric setting." + } + }, + "description": "Describes a parameter in fabric settings of the cluster." + }, + "SettingsSectionDescription": { + "type": "object", + "required": [ + "name", + "parameters" + ], + "properties": { + "name": { + "type": "string", + "description": "The section name of the fabric settings." + }, + "parameters": { + "type": "array", + "description": "The collection of parameters in the section.", + "items": { + "$ref": "#/definitions/SettingsParameterDescription" + } + } + }, + "description": "Describes a section in the fabric settings of the cluster." + }, + "SystemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "type": "object", + "readOnly": true, + "properties": { + "createdBy": { + "type": "string", + "description": "The identity that created the resource." + }, + "createdByType": { + "type": "string", + "description": "The type of identity that created the resource." + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource creation (UTC)." + }, + "lastModifiedBy": { + "type": "string", + "description": "The identity that last modified the resource." + }, + "lastModifiedByType": { + "type": "string", + "description": "The type of identity that last modified the resource." + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource last modification (UTC)." + } + } + } + }, + "parameters": { + "api-version": { + "name": "api-version", + "in": "query", + "description": "The version of the Service Fabric resource provider API. This is a required parameter and it's value must be \"2021-11-01-preview\" for this specification.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "clusterNameParameter": { + "name": "clusterName", + "in": "path", + "description": "The name of the cluster resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "clusterVersion": { + "name": "clusterVersion", + "in": "path", + "description": "The cluster code version.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "environment": { + "name": "environment", + "in": "path", + "description": "The operating system of the cluster. The default means all.", + "required": true, + "type": "string", + "enum": [ + "Windows" + ], + "x-ms-parameter-location": "method" + }, + "location": { + "name": "location", + "in": "path", + "description": "The location for the cluster code versions. This is different from cluster location.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "subscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The customer subscription identifier.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "vmSize": { + "name": "vmSize", + "in": "path", + "description": "VM Size name.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/nodetype.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/nodetype.json new file mode 100644 index 000000000000..4897fc1e0006 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/nodetype.json @@ -0,0 +1,1469 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceFabricManagementClient", + "description": "Azure Service Fabric Resource Provider API Client", + "version": "2021-11-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "type": "oauth2" + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "paths": { + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes": { + "get": { + "operationId": "NodeTypes_ListByManagedClusters", + "summary": "Gets the list of Node types of the specified managed cluster.", + "description": "Gets all Node types of the specified managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "tags": [ + "NodeType" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List node type of the specified managed cluster": { + "$ref": "./examples/NodeTypeListOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/NodeTypeListResult" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}/restart": { + "post": { + "tags": [ + "NodeType" + ], + "operationId": "NodeTypes_Restart", + "summary": "Restarts one or more nodes on the node type.", + "description": "Restarts one or more nodes on the node type. It will disable the fabric nodes, trigger a restart on the VMs and activate the nodes back again.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/nodeTypeNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "parameters for restart action.", + "required": true, + "schema": { + "$ref": "#/definitions/NodeTypeActionParameters" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Restart nodes": { + "$ref": "./examples/RestartNodes_example.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously." + }, + "200": { + "description": "The operation completed successfully." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}/reimage": { + "post": { + "tags": [ + "NodeType" + ], + "operationId": "NodeTypes_Reimage", + "summary": "Reimages one or more nodes on the node type.", + "description": "Reimages one or more nodes on the node type. It will disable the fabric nodes, trigger a reimage on the VMs and activate the nodes back again.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/nodeTypeNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "parameters for reimage action.", + "required": true, + "schema": { + "$ref": "#/definitions/NodeTypeActionParameters" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Reimage nodes": { + "$ref": "./examples/ReimageNodes_example.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously." + }, + "200": { + "description": "The operation completed successfully." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}/deleteNode": { + "post": { + "tags": [ + "NodeType" + ], + "operationId": "NodeTypes_DeleteNode", + "summary": "Deletes one or more nodes on the node type.", + "description": "Deletes one or more nodes on the node type. It will disable the fabric nodes, trigger a delete on the VMs and removes the state from the cluster.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/nodeTypeNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "parameters for delete action.", + "required": true, + "schema": { + "$ref": "#/definitions/NodeTypeActionParameters" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Delete nodes": { + "$ref": "./examples/DeleteNodes_example.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously." + }, + "200": { + "description": "The operation completed successfully." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}/skus": { + "get": { + "tags": [ + "NodeType" + ], + "operationId": "NodeTypeSkus_List", + "summary": "Gets a Service Fabric node type SKUs.", + "description": "Get a Service Fabric node type supported SKUs.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/nodeTypeNameParameter" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List a node type SKUs": { + "$ref": "./examples/NodeTypeSkusListOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/NodeTypeListSkuResult" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}": { + "get": { + "tags": [ + "NodeType" + ], + "operationId": "NodeTypes_Get", + "summary": "Gets a Service Fabric node type.", + "description": "Get a Service Fabric node type of a given managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/nodeTypeNameParameter" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Get a node type": { + "$ref": "./examples/NodeTypeGetOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/NodeType" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "put": { + "tags": [ + "NodeType" + ], + "operationId": "NodeTypes_CreateOrUpdate", + "summary": "Creates or updates a Service Fabric node type.", + "description": "Create or update a Service Fabric node type of a given managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/nodeTypeNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The node type resource.", + "required": true, + "schema": { + "$ref": "#/definitions/NodeType" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Put a node type with minimum parameters": { + "$ref": "./examples/NodeTypePutOperation_example_min.json" + }, + "Put a node type with maximum parameters": { + "$ref": "./examples/NodeTypePutOperation_example_max.json" + }, + "Put a node type with auto-scale parameters": { + "$ref": "./examples/NodeTypePutOperationAutoScale_example.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/NodeType" + } + }, + "202": { + "description": "The request was accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/NodeType" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "patch": { + "tags": [ + "NodeType" + ], + "operationId": "NodeTypes_Update", + "summary": "Update the tags of a node type resource of a given managed cluster.", + "description": "Update the configuration of a node type of a given managed cluster, only updating tags.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/nodeTypeNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The parameters to update the node type configuration.", + "required": true, + "schema": { + "$ref": "#/definitions/NodeTypeUpdateParameters" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Patch a node type": { + "$ref": "./examples/NodeTypePatchOperation_example.json" + }, + "Patch a node type while auto-scaling": { + "$ref": "./examples/NodeTypePatchOperationAutoScale_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/NodeType" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "tags": [ + "NodeType" + ], + "operationId": "NodeTypes_Delete", + "summary": "Deletes a Service Fabric node type.", + "description": "Delete a Service Fabric node type of a given managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/nodeTypeNameParameter" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Delete a node type": { + "$ref": "./examples/NodeTypeDeleteOperation_example.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously." + }, + "204": { + "description": "The resource was not found." + }, + "200": { + "description": "The operation completed successfully." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + } + }, + "definitions": { + "DiskType": { + "type": "string", + "description": "Managed data disk type. IOPS and throughput are given by the disk size, to see more information go to https://docs.microsoft.com/en-us/azure/virtual-machines/disks-types.\n", + "enum": [ + "Standard_LRS", + "StandardSSD_LRS", + "Premium_LRS" + ], + "default": "StandardSSD_LRS", + "x-ms-enum": { + "name": "DiskType", + "modelAsString": true, + "values": [ + { + "value": "Standard_LRS", + "description": "Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access." + }, + { + "value": "StandardSSD_LRS", + "description": "Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test." + }, + { + "value": "Premium_LRS", + "description": "Premium SSD locally redundant storage. Best for production and performance sensitive workloads." + } + ] + } + }, + "FrontendConfiguration": { + "type": "object", + "properties": { + "ipAddressType": { + "$ref": "#/definitions/IPAddressType", + "description": "The IP address type of this frontend configuration. If omitted the default value is IPv4." + }, + "loadBalancerBackendAddressPoolId": { + "type": "string", + "description": "The resource Id of the Load Balancer backend address pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions//resourceGroups//providers/Microsoft.Network/loadBalancers//backendAddressPools/'." + }, + "loadBalancerInboundNatPoolId": { + "type": "string", + "description": "The resource Id of the Load Balancer inbound NAT pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions//resourceGroups//providers/Microsoft.Network/loadBalancers//inboundNatPools/'." + } + }, + "description": "Describes the frontend configurations for the node type." + }, + "IPAddressType": { + "type": "string", + "description": "The IP address type.\n", + "enum": [ + "IPv4", + "IPv6" + ], + "default": "IPv4", + "x-ms-enum": { + "name": "IPAddressType", + "modelAsString": true, + "values": [ + { + "value": "IPv4", + "description": "IPv4 address type." + }, + { + "value": "IPv6", + "description": "IPv6 address type." + } + ] + } + }, + "ManagedProxyResource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Azure resource identifier.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Azure resource name.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Azure resource type.", + "readOnly": true + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Azure resource tags.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "systemData": { + "$ref": "#/definitions/SystemData" + } + }, + "description": "The resource model definition for proxy-only resource.", + "x-ms-azure-resource": true + }, + "NodeType": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ManagedProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NodeTypeProperties", + "description": "The node type properties" + }, + "sku": { + "$ref": "#/definitions/NodeTypeSku", + "description": "The node type sku." + } + }, + "description": "Describes a node type in the cluster, each node type represents sub set of nodes in the cluster." + }, + "NodeTypeActionParameters": { + "type": "object", + "required": [ + "nodes" + ], + "properties": { + "nodes": { + "description": "List of node names from the node type.", + "type": "array", + "items": { + "type": "string" + } + }, + "force": { + "description": "Force the action to go through.", + "type": "boolean" + } + }, + "description": "Parameters for Node type action." + }, + "NodeTypeProperties": { + "type": "object", + "required": [ + "isPrimary", + "vmInstanceCount", + "dataDiskSizeGB" + ], + "properties": { + "isPrimary": { + "type": "boolean", + "description": "Indicates the Service Fabric system services for the cluster will run on this node type. This setting cannot be changed once the node type is created." + }, + "vmInstanceCount": { + "type": "integer", + "format": "int32", + "description": "The number of nodes in the node type.

**Values:**
-1 - Use when auto scale rules are configured or sku.capacity is defined
0 - Not supported
>0 - Use for manual scale.", + "minimum": -1, + "maximum": 2147483647 + }, + "dataDiskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Disk size for each vm in the node type in GBs." + }, + "dataDiskType": { + "$ref": "#/definitions/DiskType", + "description": "Managed data disk type. Specifies the storage account type for the managed disk" + }, + "dataDiskLetter": { + "type": "string", + "pattern": "^[a-zA-Z]{1}$", + "description": "Managed data disk letter. It can not use the reserved letter C or D and it can not change after created." + }, + "placementProperties": { + "type": "object", + "description": "The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run.", + "additionalProperties": { + "type": "string", + "description": "Placement tag value" + } + }, + "capacities": { + "type": "object", + "description": "The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has.", + "additionalProperties": { + "type": "string", + "description": "Capacity tag value" + } + }, + "applicationPorts": { + "$ref": "#/definitions/EndpointRangeDescription", + "description": "The range of ports from which cluster assigned port to Service Fabric applications." + }, + "ephemeralPorts": { + "$ref": "#/definitions/EndpointRangeDescription", + "description": "The range of ephemeral ports that nodes in this node type should be configured with." + }, + "vmSize": { + "type": "string", + "description": "The size of virtual machines in the pool. All virtual machines in a pool are the same size. For example, Standard_D3." + }, + "vmImagePublisher": { + "type": "string", + "description": "The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer." + }, + "vmImageOffer": { + "type": "string", + "description": "The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer." + }, + "vmImageSku": { + "type": "string", + "description": "The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter." + }, + "vmImageVersion": { + "type": "string", + "description": "The version of the Azure Virtual Machines Marketplace image. A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'." + }, + "vmSecrets": { + "type": "array", + "title": "virtual machine secretes.", + "description": "The secrets to install in the virtual machines.", + "items": { + "$ref": "#/definitions/VaultSecretGroup" + } + }, + "vmExtensions": { + "type": "array", + "title": "virtual machine extensions.", + "description": "Set of extensions that should be installed onto the virtual machines.", + "items": { + "$ref": "#/definitions/VMSSExtension" + } + }, + "vmManagedIdentity": { + "$ref": "#/definitions/VmManagedIdentity", + "description": "Identities to assign to the virtual machine scale set under the node type." + }, + "isStateless": { + "type": "boolean", + "description": "Indicates if the node type can only host Stateless workloads.", + "default": false + }, + "multiplePlacementGroups": { + "type": "boolean", + "description": "Indicates if scale set associated with the node type can be composed of multiple placement groups.", + "default": false + }, + "frontendConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/FrontendConfiguration" + }, + "description": "Indicates the node type uses its own frontend configurations instead of the default one for the cluster. This setting can only be specified for non-primary node types and can not be added or removed after the node type is created." + }, + "networkSecurityRules": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkSecurityRule" + }, + "description": "The Network Security Rules for this node type. This setting can only be specified for node types that are configured with frontend configurations." + }, + "additionalDataDisks": { + "type": "array", + "items": { + "$ref": "#/definitions/VmssDataDisk" + }, + "description": "Additional managed data disks." + }, + "enableEncryptionAtHost": { + "type": "boolean", + "description": "Enable or disable the Host Encryption for the virtual machines on the node type. This will enable the encryption for all the disks including Resource/Temp disk at host itself. Default: The Encryption at host will be disabled unless this property is set to true for the resource.", + "default": false + }, + "provisioningState": { + "$ref": "#/definitions/ManagedResourceProvisioningState", + "readOnly": true, + "description": "The provisioning state of the node type resource." + }, + "enableAcceleratedNetworking": { + "type": "boolean", + "description": "Specifies whether the network interface is accelerated networking-enabled." + }, + "useDefaultPublicLoadBalancer": { + "type": "boolean", + "description": "Specifies whether the use public load balancer. If not specified and the node type doesn't have its own frontend configuration, it will be attached to the default load balancer. If the node type uses its own Load balancer and useDefaultPublicLoadBalancer is true, then the frontend has to be an Internal Load Balancer. If the node type uses its own Load balancer and useDefaultPublicLoadBalancer is false or not set, then the custom load balancer must include a public load balancer to provide outbound connectivity." + } + }, + "description": "Describes a node type in the cluster, each node type represents sub set of nodes in the cluster." + }, + "NodeTypeListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "title": "node type list value.", + "description": "The list of node types.", + "items": { + "$ref": "#/definitions/NodeType" + } + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "Node type list results" + }, + "NodeTypeUpdateParameters": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "description": "Node type update parameters", + "additionalProperties": { + "type": "string" + } + }, + "sku": { + "$ref": "#/definitions/NodeTypeSku", + "description": "The node type sku." + } + }, + "description": "Node type update request" + }, + "NodeTypeSku": { + "type": "object", + "required": [ + "capacity" + ], + "properties": { + "name": { + "type": "string", + "description": "The sku name.

Name is internally generated and is used in auto-scale scenarios.
Property does not allow to be changed to other values than generated.
To avoid deployment errors please omit the property." + }, + "tier": { + "type": "string", + "description": "Specifies the tier of the node type.

Possible Values:
**Standard**" + }, + "capacity": { + "type": "integer", + "format": "int32", + "description": "The number of nodes in the node type.

If present in request it will override properties.vmInstanceCount.", + "minimum": 1, + "maximum": 2147483647 + } + }, + "description": "Describes a node type sku." + }, + "NodeTypeSkuCapacity": { + "type": "object", + "properties": { + "minimum": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "Lowest permitted node count in a node type." + }, + "maximum": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "Highest permitted node count in a node type." + }, + "default": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "Default node count in a node type." + }, + "scaleType": { + "$ref": "#/definitions/NodeTypeSkuScaleType", + "readOnly": true, + "description": "Node type capacity scale type." + } + }, + "description": "Provides information about how node type can be scaled." + }, + "NodeTypeSkuScaleType": { + "type": "string", + "description": "Node type capacity scale type.\n", + "enum": [ + "None", + "Manual", + "Automatic" + ], + "default": "None", + "x-ms-enum": { + "name": "NodeTypeSkuScaleType", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "Node count is not adjustable in any way (e.g. it is fixed)." + }, + { + "value": "Manual", + "description": "The user must manually scale out/in." + }, + { + "value": "Automatic", + "description": "Automatic scale is allowed." + } + ] + } + }, + "NodeTypeAvailableSku": { + "type": "object", + "properties": { + "resourceType": { + "type": "string", + "readOnly": true, + "description": "The type of resource the sku applies to.

Value: Microsoft.ServiceFabric/managedClusters/nodeTypes." + }, + "sku": { + "$ref": "#/definitions/NodeTypeSupportedSku", + "description": "The supported SKU for a for node type.", + "readOnly": true + }, + "capacity": { + "$ref": "#/definitions/NodeTypeSkuCapacity", + "description": "Provides information about how the node count can be scaled.", + "readOnly": true + } + }, + "description": "Defines the type of sku available for a node type" + }, + "NodeTypeSupportedSku": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The sku name.", + "readOnly": true + }, + "tier": { + "type": "string", + "description": "Specifies the tier of the node type.

Possible Values:
**Standard**", + "readOnly": true + } + }, + "description": "Describes a node type supported sku." + }, + "NodeTypeListSkuResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "title": "Node type sku list value.", + "description": "The list of available node type SKUs.", + "items": { + "$ref": "#/definitions/NodeTypeAvailableSku" + } + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "Node type available sku list results" + }, + "SubResource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Azure resource identifier." + } + }, + "description": "Azure resource identifier.", + "x-ms-azure-resource": true + }, + "VaultCertificate": { + "type": "object", + "required": [ + "certificateUrl", + "certificateStore" + ], + "properties": { + "certificateUrl": { + "type": "string", + "description": "This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
\"data\":\"\",
\"dataType\":\"pfx\",
\"password\":\"\"
}" + }, + "certificateStore": { + "type": "string", + "description": "For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted." + } + }, + "description": "Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM." + }, + "VaultSecretGroup": { + "type": "object", + "required": [ + "sourceVault", + "vaultCertificates" + ], + "properties": { + "sourceVault": { + "$ref": "#/definitions/SubResource", + "description": "The relative URL of the Key Vault containing all of the certificates in VaultCertificates." + }, + "vaultCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/VaultCertificate" + }, + "description": "The list of key vault references in SourceVault which contain certificates." + } + }, + "description": "Specifies set of certificates that should be installed onto the virtual machines." + }, + "VmManagedIdentity": { + "type": "object", + "properties": { + "userAssignedIdentities": { + "type": "array", + "description": "The list of user identities associated with the virtual machine scale set under the node type. Each entry will be an ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.", + "items": { + "type": "string" + } + } + }, + "description": "Identities for the virtual machine scale set under the node type." + }, + "VmssDataDisk": { + "type": "object", + "required": [ + "lun", + "diskSizeGB", + "diskType", + "diskLetter" + ], + "properties": { + "lun": { + "type": "integer", + "format": "int32", + "minimum": 1, + "description": "Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. Lun 0 is reserved for the service fabric data disk." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Disk size for each vm in the node type in GBs." + }, + "diskType": { + "$ref": "#/definitions/DiskType", + "description": "Managed data disk type. Specifies the storage account type for the managed disk" + }, + "diskLetter": { + "type": "string", + "pattern": "^[a-zA-Z]{1}$", + "description": "Managed data disk letter. It can not use the reserved letter C or D and it can not change after created." + } + }, + "description": "Managed data disk description." + }, + "VMSSExtension": { + "type": "object", + "required": [ + "name", + "properties" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the extension." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VMSSExtensionProperties", + "description": "Describes the properties of a Virtual Machine Scale Set Extension." + } + }, + "description": "Specifies set of extensions that should be installed onto the virtual machines." + }, + "VMSSExtensionProperties": { + "type": "object", + "required": [ + "publisher", + "type", + "typeHandlerVersion" + ], + "properties": { + "publisher": { + "type": "string", + "description": "The name of the extension handler publisher." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + }, + "autoUpgradeMinorVersion": { + "type": "boolean", + "description": "Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true." + }, + "settings": { + "type": "object", + "description": "Json formatted public settings for the extension." + }, + "protectedSettings": { + "type": "object", + "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." + }, + "forceUpdateTag": { + "type": "string", + "description": "If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed." + }, + "provisionAfterExtensions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Collection of extension names after which this extension needs to be provisioned." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + } + }, + "description": "Describes the properties of a Virtual Machine Scale Set Extension." + }, + "AvailableOperationDisplay": { + "type": "object", + "properties": { + "provider": { + "type": "string", + "description": "The name of the provider." + }, + "resource": { + "type": "string", + "description": "The resource on which the operation is performed" + }, + "operation": { + "type": "string", + "description": "The operation that can be performed." + }, + "description": { + "type": "string", + "description": "Operation description" + } + }, + "description": "Operation supported by the Service Fabric resource provider" + }, + "EndpointRangeDescription": { + "type": "object", + "required": [ + "endPort", + "startPort" + ], + "properties": { + "startPort": { + "type": "integer", + "format": "int32", + "description": "Starting port of a range of ports" + }, + "endPort": { + "type": "integer", + "format": "int32", + "description": "End port of a range of ports" + } + }, + "description": "Port range details" + }, + "ErrorModel": { + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/ErrorModelError", + "description": "The error details." + } + }, + "description": "The structure of the error." + }, + "ErrorModelError": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The error code." + }, + "message": { + "type": "string", + "description": "The error message." + } + }, + "description": "The error details." + }, + "ManagedResourceProvisioningState": { + "type": "string", + "description": "The provisioning state of the managed resource.", + "enum": [ + "None", + "Creating", + "Created", + "Updating", + "Succeeded", + "Failed", + "Canceled", + "Deleting", + "Deleted", + "Other" + ], + "x-ms-enum": { + "name": "ManagedResourceProvisioningState", + "modelAsString": true + } + }, + "NetworkSecurityRule": { + "type": "object", + "required": [ + "name", + "protocol", + "access", + "priority", + "direction" + ], + "properties": { + "name": { + "type": "string", + "description": "Network security rule name." + }, + "description": { + "type": "string", + "description": "Network security rule description." + }, + "protocol": { + "type": "string", + "description": "Network protocol this rule applies to.", + "enum": [ + "http", + "https", + "tcp", + "udp", + "icmp", + "ah", + "esp" + ], + "x-ms-enum": { + "name": "nsgProtocol", + "modelAsString": true + } + }, + "sourceAddressPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The CIDR or source IP ranges." + }, + "destinationAddressPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The destination address prefixes. CIDR or destination IP ranges." + }, + "sourcePortRanges": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The source port ranges." + }, + "destinationPortRanges": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The destination port ranges." + }, + "sourceAddressPrefix": { + "type": "string", + "description": "The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from." + }, + "destinationAddressPrefix": { + "type": "string", + "description": "The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used." + }, + "sourcePortRange": { + "type": "string", + "description": "The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports." + }, + "destinationPortRange": { + "type": "string", + "description": "he destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports." + }, + "access": { + "type": "string", + "description": "The network traffic is allowed or denied.", + "enum": [ + "allow", + "deny" + ], + "x-ms-enum": { + "name": "access", + "modelAsString": true + } + }, + "priority": { + "type": "integer", + "format": "int32", + "description": "The priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.", + "minimum": 1000, + "maximum": 3000 + }, + "direction": { + "type": "string", + "description": "Network security rule direction.", + "enum": [ + "inbound", + "outbound" + ], + "x-ms-enum": { + "name": "direction", + "modelAsString": true + } + } + }, + "description": "Describes a network security rule." + }, + "OperationResult": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the operation." + }, + "isDataAction": { + "type": "boolean", + "description": "Indicates whether the operation is a data action" + }, + "display": { + "$ref": "#/definitions/AvailableOperationDisplay", + "description": "The object that represents the operation." + }, + "origin": { + "type": "string", + "description": "Origin result" + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "Available operation list result" + }, + "SystemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "type": "object", + "readOnly": true, + "properties": { + "createdBy": { + "type": "string", + "description": "The identity that created the resource." + }, + "createdByType": { + "type": "string", + "description": "The type of identity that created the resource." + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource creation (UTC)." + }, + "lastModifiedBy": { + "type": "string", + "description": "The identity that last modified the resource." + }, + "lastModifiedByType": { + "type": "string", + "description": "The type of identity that last modified the resource." + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource last modification (UTC)." + } + } + } + }, + "parameters": { + "api-version": { + "name": "api-version", + "in": "query", + "description": "The version of the Service Fabric resource provider API. This is a required parameter and it's value must be \"2021-11-01-preview\" for this specification.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "clusterNameParameter": { + "name": "clusterName", + "in": "path", + "description": "The name of the cluster resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "nodeTypeNameParameter": { + "name": "nodeTypeName", + "in": "path", + "description": "The name of the node type.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "subscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The customer subscription identifier.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/readme.md b/specification/servicefabricmanagedclusters/resource-manager/readme.md index d972f6b5ca98..03bc116577cf 100644 --- a/specification/servicefabricmanagedclusters/resource-manager/readme.md +++ b/specification/servicefabricmanagedclusters/resource-manager/readme.md @@ -27,7 +27,7 @@ These are the global settings for the ServiceFabricManagedClustersManagementClie title: ServiceFabricManagedClustersManagementClient description: Service Fabric Managed Clusters Management Client openapi-type: arm -tag: package-2021-07-preview +tag: package-2021-11-preview directive: - suppress: ListInOperationName @@ -69,6 +69,17 @@ directive: ``` +### Tag: package-2021-11-preview + +These settings apply only when `--tag=package-2021-11-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2021-11-preview' +input-file: +- Microsoft.ServiceFabric/preview/2021-11-01-preview/managedapplication.json +- Microsoft.ServiceFabric/preview/2021-11-01-preview/managedcluster.json +- Microsoft.ServiceFabric/preview/2021-11-01-preview/nodetype.json +``` + ### Tag: package-2021-09-privatepreview These settings apply only when `--tag=package-2021-09-privatepreview` is specified on the command line. From 2d0ce48d9400e907f032c3613c5c5385e843cda2 Mon Sep 17 00:00:00 2001 From: Mario Hernandez Date: Fri, 29 Oct 2021 01:28:47 -0700 Subject: [PATCH 16/19] Update dotnet sdk namespace for Microsoft.Chaos. (#16598) --- specification/chaos/resource-manager/readme.csharp.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/chaos/resource-manager/readme.csharp.md b/specification/chaos/resource-manager/readme.csharp.md index 79ab31dea917..12cb88c353ac 100644 --- a/specification/chaos/resource-manager/readme.csharp.md +++ b/specification/chaos/resource-manager/readme.csharp.md @@ -10,6 +10,6 @@ csharp: payload-flattening-threshold: 1 clear-output-folder: true client-side-validation: false - namespace: Microsoft.Chaos + namespace: Microsoft.Azure.Management.Chaos output-folder: $(csharp-sdks-folder)/chaos/management/Microsoft.Chaos/GeneratedProtocol ``` From 2970e417353ba5ace9234211e1858eebc1810eb5 Mon Sep 17 00:00:00 2001 From: Krishna Sri Somepalli Date: Fri, 29 Oct 2021 13:58:59 +0530 Subject: [PATCH 17/19] [Hub Generated] Review request for Microsoft.Confluent to add version preview/2021-09-01-preview (#16048) * Adds base for updating Microsoft.Confluent from version preview/2021-03-01-preview to version 2021-09-01-preview * Updates readme * Updates API version in new specs and examples * Fixing spellcheck (#16551) --- cSpell.json | 2 +- .../preview/2021-09-01-preview/confluent.json | 971 ++++++++++++++++++ .../MarketplaceAgreements_Create.json | 38 + .../examples/MarketplaceAgreements_List.json | 45 + .../examples/OrganizationOperations_List.json | 44 + .../examples/Organization_Create.json | 98 ++ .../examples/Organization_Delete.json | 13 + .../examples/Organization_Get.json | 48 + .../Organization_ListByResourceGroup.json | 44 + .../Organization_ListBySubscription.json | 43 + .../examples/Organization_Update.json | 54 + .../Validations_ValidateOrganizations.json | 60 ++ .../confluent/resource-manager/readme.md | 20 +- 13 files changed, 1473 insertions(+), 7 deletions(-) create mode 100644 specification/confluent/resource-manager/Microsoft.Confluent/preview/2021-09-01-preview/confluent.json create mode 100644 specification/confluent/resource-manager/Microsoft.Confluent/preview/2021-09-01-preview/examples/MarketplaceAgreements_Create.json create mode 100644 specification/confluent/resource-manager/Microsoft.Confluent/preview/2021-09-01-preview/examples/MarketplaceAgreements_List.json create mode 100644 specification/confluent/resource-manager/Microsoft.Confluent/preview/2021-09-01-preview/examples/OrganizationOperations_List.json create mode 100644 specification/confluent/resource-manager/Microsoft.Confluent/preview/2021-09-01-preview/examples/Organization_Create.json create mode 100644 specification/confluent/resource-manager/Microsoft.Confluent/preview/2021-09-01-preview/examples/Organization_Delete.json create mode 100644 specification/confluent/resource-manager/Microsoft.Confluent/preview/2021-09-01-preview/examples/Organization_Get.json create mode 100644 specification/confluent/resource-manager/Microsoft.Confluent/preview/2021-09-01-preview/examples/Organization_ListByResourceGroup.json create mode 100644 specification/confluent/resource-manager/Microsoft.Confluent/preview/2021-09-01-preview/examples/Organization_ListBySubscription.json create mode 100644 specification/confluent/resource-manager/Microsoft.Confluent/preview/2021-09-01-preview/examples/Organization_Update.json create mode 100644 specification/confluent/resource-manager/Microsoft.Confluent/preview/2021-09-01-preview/examples/Validations_ValidateOrganizations.json diff --git a/cSpell.json b/cSpell.json index 28ac16da7eae..73b4d1e454e5 100644 --- a/cSpell.json +++ b/cSpell.json @@ -834,7 +834,7 @@ ] }, { - "filename": "**/specification/confluent/resource-manager/Microsoft.Confluent/preview/2021-03-01-preview/confluent.json", + "filename": "**/specification/confluent/resource-manager/Microsoft.Confluent/preview/*/confluent.json", "words": [ "orgvalidate" ] diff --git a/specification/confluent/resource-manager/Microsoft.Confluent/preview/2021-09-01-preview/confluent.json b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2021-09-01-preview/confluent.json new file mode 100644 index 000000000000..f2a530d17ce4 --- /dev/null +++ b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2021-09-01-preview/confluent.json @@ -0,0 +1,971 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.Confluent", + "version": "2021-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Confluent/agreements": { + "get": { + "tags": [ + "Agreements" + ], + "summary": "List Confluent marketplace agreements in the subscription.", + "operationId": "MarketplaceAgreements_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ConfluentAgreementResourceListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "MarketplaceAgreements_List": { + "$ref": "./examples/MarketplaceAgreements_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Confluent/agreements/default": { + "put": { + "tags": [ + "Agreements" + ], + "summary": "Create Confluent Marketplace agreement in the subscription.", + "operationId": "MarketplaceAgreements_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "in": "body", + "name": "body", + "description": "Confluent Marketplace Agreement resource", + "schema": { + "$ref": "#/definitions/ConfluentAgreementResource" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ConfluentAgreementResource" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "MarketplaceAgreements_Create": { + "$ref": "./examples/MarketplaceAgreements_Create.json" + } + } + } + }, + "/providers/Microsoft.Confluent/operations": { + "get": { + "tags": [ + "Organization" + ], + "summary": "List all operations provided by Microsoft.Confluent.", + "operationId": "OrganizationOperations_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "OrganizationOperations_List": { + "$ref": "./examples/OrganizationOperations_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Confluent/organizations": { + "get": { + "tags": [ + "Organization" + ], + "summary": "List all organizations under the specified subscription.", + "operationId": "Organization_ListBySubscription", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OrganizationResourceListResult" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Organization_ListBySubscription": { + "$ref": "./examples/Organization_ListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations": { + "get": { + "tags": [ + "Organization" + ], + "summary": "List all Organizations under the specified resource group.", + "operationId": "Organization_ListByResourceGroup", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OrganizationResourceListResult" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Organization_ListByResourceGroup": { + "$ref": "./examples/Organization_ListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}": { + "get": { + "tags": [ + "Organization" + ], + "summary": "Get the properties of a specific Organization resource.", + "operationId": "Organization_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/OrganizationResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OrganizationResource" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Organization_Get": { + "$ref": "./examples/Organization_Get.json" + } + } + }, + "put": { + "tags": [ + "Organization" + ], + "summary": "Create Organization resource", + "operationId": "Organization_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/OrganizationResourceNameParameter" + }, + { + "in": "body", + "name": "body", + "description": "Organization resource model", + "schema": { + "$ref": "#/definitions/OrganizationResource" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OrganizationResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/OrganizationResource" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Organization_Create": { + "$ref": "./examples/Organization_Create.json" + } + } + }, + "patch": { + "tags": [ + "Organization" + ], + "summary": "Update Organization resource", + "operationId": "Organization_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/OrganizationResourceNameParameter" + }, + { + "in": "body", + "name": "body", + "description": "Updated Organization resource", + "schema": { + "$ref": "#/definitions/OrganizationResourceUpdate" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OrganizationResource" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Confluent_Update": { + "$ref": "./examples/Organization_Update.json" + } + } + }, + "delete": { + "tags": [ + "Organization" + ], + "summary": "Delete Organization resource", + "operationId": "Organization_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/OrganizationResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "The specified confluent resource does not exist in the subscription." + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Confluent_Delete": { + "$ref": "./examples/Organization_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/validations/{organizationName}/orgvalidate": { + "post": { + "tags": [ + "Validations" + ], + "summary": "Organization Validate proxy resource", + "operationId": "Validations_ValidateOrganization", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/OrganizationResourceNameParameter" + }, + { + "in": "body", + "name": "body", + "required": true, + "description": "Organization resource model", + "schema": { + "$ref": "#/definitions/OrganizationResource" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OrganizationResource" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Validations_ValidateOrganizations": { + "$ref": "./examples/Validations_ValidateOrganizations.json" + } + } + } + } + }, + "definitions": { + "ConfluentAgreementProperties": { + "description": "Terms properties for Marketplace and Confluent.", + "type": "object", + "properties": { + "publisher": { + "description": "Publisher identifier string.", + "type": "string" + }, + "product": { + "description": "Product identifier string.", + "type": "string" + }, + "plan": { + "description": "Plan identifier string.", + "type": "string" + }, + "licenseTextLink": { + "description": "Link to HTML with Microsoft and Publisher terms.", + "type": "string" + }, + "privacyPolicyLink": { + "description": "Link to the privacy policy of the publisher.", + "type": "string" + }, + "retrieveDatetime": { + "format": "date-time", + "description": "Date and time in UTC of when the terms were accepted. This is empty if Accepted is false.", + "type": "string" + }, + "signature": { + "description": "Terms signature.", + "type": "string" + }, + "accepted": { + "description": "If any version of the terms have been accepted, otherwise false.", + "type": "boolean" + } + } + }, + "ConfluentAgreementResource": { + "description": "Agreement Terms definition", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "id": { + "description": "The ARM id of the resource.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the agreement.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the agreement.", + "type": "string", + "readOnly": true + }, + "systemData": { + "description": "Metadata pertaining to creation and last modification of the resource", + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ConfluentAgreementProperties", + "description": "Represents the properties of the resource." + } + } + }, + "ConfluentAgreementResourceListResponse": { + "description": "Response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "items": { + "$ref": "#/definitions/ConfluentAgreementResource" + } + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "OperationDisplay": { + "description": "The object that represents the operation.", + "type": "object", + "properties": { + "provider": { + "description": "Service provider: Microsoft.Confluent", + "type": "string" + }, + "resource": { + "description": "Type on which the operation is performed, e.g., 'clusters'.", + "type": "string" + }, + "operation": { + "description": "Operation type, e.g., read, write, delete, etc.", + "type": "string" + }, + "description": { + "description": "Description of the operation, e.g., 'Write confluent'.", + "type": "string" + } + } + }, + "OperationResult": { + "description": "An Confluent REST API operation.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "description": "The object that represents the operation.", + "$ref": "#/definitions/OperationDisplay" + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "boolean" + } + } + }, + "OperationListResult": { + "description": "Result of GET request to list Confluent operations.", + "type": "object", + "properties": { + "value": { + "description": "List of Confluent operations supported by the Microsoft.Confluent provider.", + "type": "array", + "items": { + "$ref": "#/definitions/OperationResult" + } + }, + "nextLink": { + "description": "URL to get the next set of operation list results if there are any.", + "type": "string" + } + } + }, + "ErrorResponseBody": { + "description": "Response body of Error", + "title": "ErrorResponseBody", + "type": "object", + "properties": { + "code": { + "description": "Error code", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Error message", + "type": "string", + "readOnly": true + }, + "target": { + "description": "Error target", + "type": "string", + "readOnly": true + }, + "details": { + "description": "Error detail", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ErrorResponseBody" + } + } + } + }, + "ResourceProviderDefaultErrorResponse": { + "type": "object", + "description": "Default error response for resource provider", + "title": "ResourceProviderDefaultErrorResponse", + "properties": { + "error": { + "description": "Response body of Error", + "readOnly": true, + "$ref": "#/definitions/ErrorResponseBody" + } + } + }, + "ProvisioningState": { + "enum": [ + "Accepted", + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled", + "Deleted", + "NotSpecified" + ], + "type": "string", + "description": "Provision states for confluent RP", + "title": "ProvisioningState", + "x-ms-enum": { + "name": "ProvisionState", + "modelAsString": true + } + }, + "SaaSOfferStatus": { + "enum": [ + "Started", + "PendingFulfillmentStart", + "InProgress", + "Subscribed", + "Suspended", + "Reinstated", + "Succeeded", + "Failed", + "Unsubscribed", + "Updating" + ], + "type": "string", + "description": "SaaS Offer Status for confluent RP", + "title": "SaaSOfferStatus", + "x-ms-enum": { + "modelAsString": true, + "name": "SaaSOfferStatus" + } + }, + "OfferDetail": { + "description": "Confluent Offer detail", + "type": "object", + "required": [ + "publisherId", + "id", + "planId", + "planName", + "termUnit" + ], + "properties": { + "publisherId": { + "description": "Publisher Id", + "maxLength": 50, + "type": "string" + }, + "id": { + "description": "Offer Id", + "maxLength": 50, + "type": "string" + }, + "planId": { + "description": "Offer Plan Id", + "maxLength": 50, + "type": "string" + }, + "planName": { + "description": "Offer Plan Name", + "maxLength": 50, + "type": "string" + }, + "termUnit": { + "description": "Offer Plan Term unit", + "maxLength": 25, + "type": "string" + }, + "status": { + "description": "SaaS Offer Status", + "$ref": "#/definitions/SaaSOfferStatus" + } + } + }, + "UserDetail": { + "description": "Subscriber detail", + "type": "object", + "required": [ + "emailAddress" + ], + "properties": { + "firstName": { + "description": "First name", + "maxLength": 50, + "type": "string" + }, + "lastName": { + "description": "Last name", + "maxLength": 50, + "type": "string" + }, + "emailAddress": { + "description": "Email address", + "pattern": "^\\S+@\\S+\\.\\S+$", + "type": "string" + } + } + }, + "OrganizationResourceProperties": { + "description": "Organization resource property", + "type": "object", + "required": [ + "offerDetail", + "userDetail" + ], + "properties": { + "createdTime": { + "format": "date-time", + "description": "The creation time of the resource.", + "type": "string", + "readOnly": true + }, + "provisioningState": { + "description": "Provision states for confluent RP", + "$ref": "#/definitions/ProvisioningState", + "readOnly": true + }, + "organizationId": { + "description": "Id of the Confluent organization.", + "type": "string", + "readOnly": true + }, + "ssoUrl": { + "description": "SSO url for the Confluent organization.", + "type": "string", + "readOnly": true + }, + "offerDetail": { + "description": "Confluent offer detail", + "$ref": "#/definitions/OfferDetail" + }, + "userDetail": { + "description": "Subscriber detail", + "$ref": "#/definitions/UserDetail" + } + } + }, + "OrganizationResource": { + "description": "Organization resource.", + "type": "object", + "x-ms-azure-resource": true, + "required": [ + "properties" + ], + "properties": { + "id": { + "description": "The ARM id of the resource.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the resource.", + "type": "string", + "readOnly": true + }, + "systemData": { + "description": "Metadata pertaining to creation and last modification of the resource", + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + }, + "properties": { + "x-ms-client-flatten": true, + "description": "Organization resource properties", + "$ref": "#/definitions/OrganizationResourceProperties" + }, + "tags": { + "type": "object", + "description": "Organization resource tags", + "additionalProperties": { + "type": "string" + } + }, + "location": { + "description": "Location of Organization resource", + "type": "string" + } + } + }, + "OrganizationResourceListResult": { + "description": "The response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Result of a list operation.", + "type": "array", + "items": { + "$ref": "#/definitions/OrganizationResource" + } + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "OrganizationResourceUpdate": { + "description": "Organization Resource update", + "type": "object", + "properties": { + "tags": { + "description": "ARM resource tags", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "Client Api Version.", + "required": true, + "type": "string", + "enum": [ + "2021-09-01-preview" + ] + }, + "SubscriptionIdParameter": { + "in": "path", + "name": "subscriptionId", + "description": "Microsoft Azure subscription id", + "required": true, + "type": "string" + }, + "ResourceGroupParameter": { + "in": "path", + "name": "resourceGroupName", + "description": "Resource group name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "OrganizationResourceNameParameter": { + "in": "path", + "name": "organizationName", + "description": "Organization resource name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/confluent/resource-manager/Microsoft.Confluent/preview/2021-09-01-preview/examples/MarketplaceAgreements_Create.json b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2021-09-01-preview/examples/MarketplaceAgreements_Create.json new file mode 100644 index 000000000000..3104ced9356c --- /dev/null +++ b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2021-09-01-preview/examples/MarketplaceAgreements_Create.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2021-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "requestBody": { + "properties": { + "accepted": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Confluent/agreements/default", + "name": "default", + "type": "Microsoft.Confluent/agreements", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-05-09T14:28:47.284Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-05-09T14:28:47.284Z" + }, + "properties": { + "publisher": "pubid1", + "product": "offid1", + "plan": "planid1", + "licenseTextLink": "test.licenseLink1", + "privacyPolicyLink": "test.privacyPolicyLink1", + "retrieveDatetime": "2020-11-05T17:33:07.12132Z", + "signature": "YKWOQOKH2BCKZ46O7SCKHANWEENRFRU5WB4LXDFUYWCBWTS4AG4SGQXCOZYIR5ZJCZTXRMZKYZMO2BJSL5YKPLAR4LBFRUNS6CRYE7A", + "accepted": true + } + } + } + } +} diff --git a/specification/confluent/resource-manager/Microsoft.Confluent/preview/2021-09-01-preview/examples/MarketplaceAgreements_List.json b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2021-09-01-preview/examples/MarketplaceAgreements_List.json new file mode 100644 index 000000000000..fa7cb5839d62 --- /dev/null +++ b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2021-09-01-preview/examples/MarketplaceAgreements_List.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2021-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Confluent/agreements/default", + "name": "planid1", + "type": "Microsoft.Confluent/agreements", + "properties": { + "publisher": "pubid1", + "product": "offid1", + "plan": "planid1", + "licenseTextLink": "test.licenseLink1", + "privacyPolicyLink": "test.privacyPolicyLink1", + "retrieveDatetime": "2017-08-15T11:33:07.12132Z", + "signature": "ASDFSDAFWEFASDGWERLWER", + "accepted": true + } + }, + { + "id": "id2", + "name": "planid2", + "type": "Microsoft.MarketplaceOrdering/offertypes", + "properties": { + "publisher": "pubid2", + "product": "offid2", + "plan": "planid2", + "licenseTextLink": "test.licenseLin2k", + "privacyPolicyLink": "test.privacyPolicyLink2", + "retrieveDatetime": "2017-08-14T11:33:07.12132Z", + "signature": "ASDFSDAFWEFASDGWERLWER", + "accepted": true + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/confluent/resource-manager/Microsoft.Confluent/preview/2021-09-01-preview/examples/OrganizationOperations_List.json b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2021-09-01-preview/examples/OrganizationOperations_List.json new file mode 100644 index 000000000000..b9769ec3de3e --- /dev/null +++ b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2021-09-01-preview/examples/OrganizationOperations_List.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2021-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Confluent/organizations/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Confluent", + "resource": "organizations", + "operation": "Get/List organization resources", + "description": "Read organization" + } + }, + { + "name": "Microsoft.Confluent/organizations/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Confluent", + "resource": "organizations", + "operation": "Create/Update organization resources", + "description": "Write organization" + } + }, + { + "name": "Microsoft.Confluent/organizations/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.Confluent", + "resource": "organizations", + "operation": "Delete organization resources", + "description": "Delete organization" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/confluent/resource-manager/Microsoft.Confluent/preview/2021-09-01-preview/examples/Organization_Create.json b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2021-09-01-preview/examples/Organization_Create.json new file mode 100644 index 000000000000..5147d436815e --- /dev/null +++ b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2021-09-01-preview/examples/Organization_Create.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "api-version": "2021-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "organizationName": "myOrganization", + "body": { + "properties": { + "offerDetail": { + "publisherId": "string", + "id": "string", + "planId": "string", + "planName": "string", + "termUnit": "string" + }, + "userDetail": { + "firstName": "string", + "lastName": "string", + "emailAddress": "contoso@microsoft.com" + } + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Confluent/organizations/myOrganization", + "name": "myOrganization", + "type": "Microsoft.Confluent/organizations", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-05-09T14:28:47.284Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-05-09T14:28:47.284Z" + }, + "properties": { + "createdTime": "2020-05-09T14:28:47.284Z", + "provisioningState": "Succeeded", + "organizationId": "string", + "ssoUrl": "string", + "offerDetail": { + "publisherId": "string", + "id": "string", + "planId": "string", + "planName": "string", + "termUnit": "string", + "status": "Started" + }, + "userDetail": { + "firstName": "string", + "lastName": "string", + "emailAddress": "contoso@microsoft.com" + } + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US" + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Confluent/organizations/myOrganization", + "name": "myOrganization", + "type": "Microsoft.Confluent/organizations", + "properties": { + "createdTime": "2020-05-09T14:28:47.284Z", + "provisioningState": "Accepted", + "organizationId": "string", + "ssoUrl": "string", + "offerDetail": { + "publisherId": "string", + "id": "string", + "planId": "string", + "planName": "string", + "termUnit": "string", + "status": "Started" + }, + "userDetail": { + "firstName": "string", + "lastName": "string", + "emailAddress": "contoso@microsoft.com" + } + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US" + } + } + } +} diff --git a/specification/confluent/resource-manager/Microsoft.Confluent/preview/2021-09-01-preview/examples/Organization_Delete.json b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2021-09-01-preview/examples/Organization_Delete.json new file mode 100644 index 000000000000..23925b7ae870 --- /dev/null +++ b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2021-09-01-preview/examples/Organization_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2021-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "organizationName": "myOrganization" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/confluent/resource-manager/Microsoft.Confluent/preview/2021-09-01-preview/examples/Organization_Get.json b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2021-09-01-preview/examples/Organization_Get.json new file mode 100644 index 000000000000..a17a9c72675b --- /dev/null +++ b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2021-09-01-preview/examples/Organization_Get.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2021-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "organizationName": "myOrganization" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Confluent/organizations/myOrganization", + "name": "myOrganization", + "type": "Microsoft.Confluent/organizations", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-05-09T14:28:47.284Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-05-09T14:28:47.284Z" + }, + "properties": { + "createdTime": "2020-05-09T14:28:47.284Z", + "provisioningState": "Accepted", + "organizationId": "string", + "ssoUrl": "string", + "offerDetail": { + "publisherId": "string", + "id": "string", + "planId": "string", + "planName": "string", + "termUnit": "string", + "status": "Started" + }, + "userDetail": { + "firstName": "string", + "lastName": "string", + "emailAddress": "contoso@microsoft.com" + } + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US" + } + } + } +} diff --git a/specification/confluent/resource-manager/Microsoft.Confluent/preview/2021-09-01-preview/examples/Organization_ListByResourceGroup.json b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2021-09-01-preview/examples/Organization_ListByResourceGroup.json new file mode 100644 index 000000000000..422dbf0c65f4 --- /dev/null +++ b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2021-09-01-preview/examples/Organization_ListByResourceGroup.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2021-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Confluent/organizations/myOrganizations", + "name": "myOrganizations", + "type": "Microsoft.Confluent/organizations", + "properties": { + "createdTime": "2020-05-09T14:28:47.284Z", + "provisioningState": "Accepted", + "organizationId": "string", + "ssoUrl": "string", + "offerDetail": { + "publisherId": "string", + "id": "string", + "planId": "string", + "planName": "string", + "termUnit": "string", + "status": "Started" + }, + "userDetail": { + "firstName": "string", + "lastName": "string", + "emailAddress": "contoso@microsoft.com" + } + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US" + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/confluent/resource-manager/Microsoft.Confluent/preview/2021-09-01-preview/examples/Organization_ListBySubscription.json b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2021-09-01-preview/examples/Organization_ListBySubscription.json new file mode 100644 index 000000000000..3718d7237243 --- /dev/null +++ b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2021-09-01-preview/examples/Organization_ListBySubscription.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2021-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Confluent/organizations/myOrganizations", + "name": "myOrganizations", + "type": "Microsoft.Confluent/organizations", + "properties": { + "createdTime": "2020-05-09T14:28:47.284Z", + "provisioningState": "Accepted", + "organizationId": "string", + "ssoUrl": "string", + "offerDetail": { + "publisherId": "string", + "id": "string", + "planId": "string", + "planName": "string", + "termUnit": "string", + "status": "Started" + }, + "userDetail": { + "firstName": "string", + "lastName": "string", + "emailAddress": "contoso@microsoft.com" + } + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US" + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/confluent/resource-manager/Microsoft.Confluent/preview/2021-09-01-preview/examples/Organization_Update.json b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2021-09-01-preview/examples/Organization_Update.json new file mode 100644 index 000000000000..6e855d4649f1 --- /dev/null +++ b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2021-09-01-preview/examples/Organization_Update.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2021-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "organizationName": "myOrganization", + "body": { + "tags": { + "env": "dev", + "client": "dev-client" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Confluent/organizations/myOrganization", + "name": "myOrganization", + "type": "Microsoft.Confluent/organizations", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-05-09T14:28:47.284Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-05-09T14:28:47.284Z" + }, + "properties": { + "createdTime": "2020-05-09T14:28:47.284Z", + "provisioningState": "Succeeded", + "organizationId": "string", + "ssoUrl": "string", + "offerDetail": { + "publisherId": "string", + "id": "string", + "planId": "string", + "planName": "string", + "termUnit": "string", + "status": "Started" + }, + "userDetail": { + "firstName": "string", + "lastName": "string", + "emailAddress": "contoso@microsoft.com" + } + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US" + } + } + } +} diff --git a/specification/confluent/resource-manager/Microsoft.Confluent/preview/2021-09-01-preview/examples/Validations_ValidateOrganizations.json b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2021-09-01-preview/examples/Validations_ValidateOrganizations.json new file mode 100644 index 000000000000..3bf81a922153 --- /dev/null +++ b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2021-09-01-preview/examples/Validations_ValidateOrganizations.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2021-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "organizationName": "myOrganization", + "body": { + "properties": { + "offerDetail": { + "publisherId": "string", + "id": "string", + "planId": "string", + "planName": "string", + "termUnit": "string" + }, + "userDetail": { + "firstName": "string", + "lastName": "string", + "emailAddress": "abc@microsoft.com" + } + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Confluent/organizations/myOrganization", + "name": "myOrganization", + "type": "Microsoft.Confluent/organizations", + "properties": { + "createdTime": "2020-05-09T14:28:47.284Z", + "provisioningState": "Succeeded", + "organizationId": "string", + "ssoUrl": "string", + "offerDetail": { + "publisherId": "string", + "id": "string", + "planId": "string", + "planName": "string", + "termUnit": "string", + "status": "Started" + }, + "userDetail": { + "firstName": "string", + "lastName": "string", + "emailAddress": "abc@microsoft.com" + } + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US" + } + } + } +} diff --git a/specification/confluent/resource-manager/readme.md b/specification/confluent/resource-manager/readme.md index 8780a27ab0d6..1653aafcc649 100644 --- a/specification/confluent/resource-manager/readme.md +++ b/specification/confluent/resource-manager/readme.md @@ -4,10 +4,10 @@ This is the AutoRest configuration file for Confluent. - - --- + ## Getting Started + To build the SDK for Confluent, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: > `autorest` @@ -15,22 +15,31 @@ To build the SDK for Confluent, simply [Install AutoRest](https://aka.ms/autores To see additional help and options, run: > `autorest --help` + --- ## Configuration - - ### Basic Information + These are the global settings for the Confluent API. ``` yaml title: ConfluentManagementClient openapi-type: arm openapi-subtype: rpaas -tag: package-2021-03-01-preview +tag: package-preview-2021-09 ``` + +### Tag: package-preview-2021-09 + +These settings apply only when `--tag=package-preview-2021-09` is specified on the command line. + +```yaml $(tag) == 'package-preview-2021-09' +input-file: + - Microsoft.Confluent/preview/2021-09-01-preview/confluent.json +``` ### Tag: package-2020-03-01 These settings apply only when `--tag=package-2020-03-01` is specified on the command line. @@ -107,4 +116,3 @@ See configuration in [readme.ruby.md](./readme.ruby.md) ## TypeScript See configuration in [readme.typescript.md](./readme.typescript.md) - From a81d2218d5effded7c615dba5371a6eed151516e Mon Sep 17 00:00:00 2001 From: Johnson Yang Date: Wed, 27 Oct 2021 11:02:30 -0700 Subject: [PATCH 18/19] IoT Central Public API 1.1-preview Oct Release (#16514) * Add new 2.0-preview.1 version for IoT Central * fix typo on enum value * rollback 1.0 changes, applied 2.0-preview.1 * fix typo * remove non-used examples * fix style * update version from 2.0-preview.1 to 1.1-preview * update code review comments, fix patch consumes with json-patch support, fix examples for fileupload * add nextLink to collection of orgs * fix typo * fix wrong position of paging * fix the paging * add . to description * update default to use enum for api-version * add oct release with query, cde v2, device filter, device template filter, relationship, edge template, simplified template patching * update examples * fix lint error, model validation * fix missing type in examples, remove url format * fix ID case * fix id case * fix ID case * add iotc query language reference * fix typo --- custom-words.txt | 5 + .../dataexports_destinations_create_adx.json | 42 + .../dataexports_destinations_create_blob.json | 34 + ...aexports_destinations_create_eventhub.json | 32 + ...dataexports_destinations_create_queue.json | 32 + ...dataexports_destinations_create_topic.json | 32 + ...taexports_destinations_create_webhook.json | 38 + .../dataexports_destinations_delete.json | 13 + ...dataexports_destinations_exports_list.json | 32 + .../dataexports_destinations_get.json | 33 + .../dataexports_destinations_list.json | 86 + ...taexports_destinations_update_webhook.json | 35 + .../examples/dataexports_exports_create.json | 50 + .../examples/dataexports_exports_delete.json | 13 + ...dataexports_exports_destinations_list.json | 26 + .../examples/dataexports_exports_get.json | 33 + .../examples/dataexports_exports_list.json | 67 + .../examples/dataexports_exports_update.json | 42 + .../devices_relationships_create.json | 26 + .../devices_relationships_delete.json | 14 + .../examples/devices_relationships_get.json | 21 + .../examples/devices_relationships_list.json | 36 + .../devices_relationships_update.json | 24 + .../examples/devicetemplates_create.json | 182 ++ .../examples/devicetemplates_get.json | 91 + .../examples/devicetemplates_list.json | 91 + .../examples/devicetemplates_update.json | 352 ++++ .../1.1-preview/examples/fileUpload_get.json | 1 - .../1.1-preview/examples/query_run.json | 65 + .../preview/1.1-preview/iotcentral.json | 1606 ++++++++++++++++- 30 files changed, 3078 insertions(+), 76 deletions(-) create mode 100644 specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_destinations_create_adx.json create mode 100644 specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_destinations_create_blob.json create mode 100644 specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_destinations_create_eventhub.json create mode 100644 specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_destinations_create_queue.json create mode 100644 specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_destinations_create_topic.json create mode 100644 specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_destinations_create_webhook.json create mode 100644 specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_destinations_delete.json create mode 100644 specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_destinations_exports_list.json create mode 100644 specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_destinations_get.json create mode 100644 specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_destinations_list.json create mode 100644 specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_destinations_update_webhook.json create mode 100644 specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_exports_create.json create mode 100644 specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_exports_delete.json create mode 100644 specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_exports_destinations_list.json create mode 100644 specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_exports_get.json create mode 100644 specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_exports_list.json create mode 100644 specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_exports_update.json create mode 100644 specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/devices_relationships_create.json create mode 100644 specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/devices_relationships_delete.json create mode 100644 specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/devices_relationships_get.json create mode 100644 specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/devices_relationships_list.json create mode 100644 specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/devices_relationships_update.json create mode 100644 specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/devicetemplates_update.json create mode 100644 specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/query_run.json diff --git a/custom-words.txt b/custom-words.txt index e7393e7224cc..4ff4de7d8576 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -2414,6 +2414,11 @@ pmem rawphysical rawvirtual sesparse +blobstorage +dataexplorer +servicebusqueue +servicebustopic +dataexports stackset CSPM autoprovisioning diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_destinations_create_adx.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_destinations_create_adx.json new file mode 100644 index 000000000000..9f7dddc333e1 --- /dev/null +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_destinations_create_adx.json @@ -0,0 +1,42 @@ +{ + "title": "Create data export ADX destination", + "description": "Create an ADX destination with an Id.", + "parameters": { + "baseDomain": "azureiotcentral.com", + "subdomain": "appsubdomain", + "destinationId": "destination1", + "api-version": "1.1-preview", + "body": { + "displayName": "Azure Data Explorer", + "type": "dataexplorer@v1", + "clusterUrl": "https://[clusterName].westus2.kusto.windows.net", + "database": "database1", + "table": "table1", + "authorization": { + "type": "servicePrincipal", + "clientId": "3b420743-2020-44c6-9b70-cc42f945db0x", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "clientSecret": "[Secret]" + } + } + }, + "responses": { + "200": { + "body": { + "id": "destination1", + "displayName": "Azure Data Explorer", + "type": "dataexplorer@v1", + "clusterUrl": "https://[clusterName].westus2.kusto.windows.net", + "database": "database1", + "table": "table1", + "authorization": { + "type": "servicePrincipal", + "clientId": "3b420743-2020-44c6-9b70-cc42f945db0x", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "clientSecret": "*****" + }, + "status": "waiting" + } + } + } +} diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_destinations_create_blob.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_destinations_create_blob.json new file mode 100644 index 000000000000..b5e713f1eacd --- /dev/null +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_destinations_create_blob.json @@ -0,0 +1,34 @@ +{ + "title": "Create data export Blob Storage destination", + "description": "Create a Blob Storage destination with an Id.", + "parameters": { + "baseDomain": "azureiotcentral.com", + "subdomain": "appsubdomain", + "destinationId": "destination1", + "api-version": "1.1-preview", + "body": { + "displayName": "Blob Storage", + "type": "blobstorage@v1", + "authorization": { + "type": "connectionString", + "connectionString": "DefaultEndpointsProtocol=https;AccountName=[accountName];AccountKey=[key];EndpointSuffix=core.windows.net", + "containerName": "test" + } + } + }, + "responses": { + "200": { + "body": { + "id": "destination1", + "displayName": "Blob Storage", + "type": "blobstorage@v1", + "authorization": { + "type": "connectionString", + "connectionString": "DefaultEndpointsProtocol=https;AccountName=[accountName];AccountKey=*****;EndpointSuffix=core.windows.net", + "containerName": "test" + }, + "status": "waiting" + } + } + } +} diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_destinations_create_eventhub.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_destinations_create_eventhub.json new file mode 100644 index 000000000000..8434210d4359 --- /dev/null +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_destinations_create_eventhub.json @@ -0,0 +1,32 @@ +{ + "title": "Create data export Event Hub destination", + "description": "Create an Event hub destination with an Id.", + "parameters": { + "baseDomain": "azureiotcentral.com", + "subdomain": "appsubdomain", + "destinationId": "destination1", + "api-version": "1.1-preview", + "body": { + "displayName": "Event Hub", + "type": "eventhubs@v1", + "authorization": { + "type": "connectionString", + "connectionString": "Endpoint=sb://[hubName].servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=[Key];EntityPath=entityPath1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "destination1", + "displayName": "Event Hub", + "type": "eventhubs@v1", + "authorization": { + "type": "connectionString", + "connectionString": "Endpoint=sb://[hubName].servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=*****;EntityPath=entityPath1" + }, + "status": "waiting" + } + } + } +} diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_destinations_create_queue.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_destinations_create_queue.json new file mode 100644 index 000000000000..81baaf783c76 --- /dev/null +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_destinations_create_queue.json @@ -0,0 +1,32 @@ +{ + "title": "Create data export Service Bus Queue destination", + "description": "Create an Service Bus Queue destination with an Id.", + "parameters": { + "baseDomain": "azureiotcentral.com", + "subdomain": "appsubdomain", + "destinationId": "destination1", + "api-version": "1.1-preview", + "body": { + "displayName": "Service Bus Queue", + "type": "servicebusqueue@v1", + "authorization": { + "type": "connectionString", + "connectionString": "Endpoint=sb://[namespance].servicebus.windows.net/;SharedAccessKeyName=xxx;SharedAccessKey=[key];EntityPath=[name]" + } + } + }, + "responses": { + "200": { + "body": { + "id": "destination1", + "displayName": "Service Bus Queue", + "type": "servicebusqueue@v1", + "authorization": { + "type": "connectionString", + "connectionString": "Endpoint=sb://[namespace].servicebus.windows.net/;SharedAccessKeyName=xxx;SharedAccessKey=*****;EntityPath=[name]" + }, + "status": "waiting" + } + } + } +} diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_destinations_create_topic.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_destinations_create_topic.json new file mode 100644 index 000000000000..34d7c59356e1 --- /dev/null +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_destinations_create_topic.json @@ -0,0 +1,32 @@ +{ + "title": "Create data export Event Hub destination", + "description": "Create an Event hub destination with an Id.", + "parameters": { + "baseDomain": "azureiotcentral.com", + "subdomain": "appsubdomain", + "destinationId": "destination1", + "api-version": "1.1-preview", + "body": { + "displayName": "Service Bus Topic", + "type": "servicebustopic@v1", + "authorization": { + "type": "connectionString", + "connectionString": "Endpoint=sb://[namespace].servicebus.windows.net/;SharedAccessKeyName=xxx;SharedAccessKey=[key];EntityPath=[name]" + } + } + }, + "responses": { + "200": { + "body": { + "id": "destination1", + "displayName": "Service Bus Topic", + "type": "servicebustopic@v1", + "authorization": { + "type": "connectionString", + "connectionString": "Endpoint=sb://[namespace].servicebus.windows.net/;SharedAccessKeyName=xxx;SharedAccessKey=*****;EntityPath=[name]" + }, + "status": "waiting" + } + } + } +} diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_destinations_create_webhook.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_destinations_create_webhook.json new file mode 100644 index 000000000000..299cd1626b54 --- /dev/null +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_destinations_create_webhook.json @@ -0,0 +1,38 @@ +{ + "title": "Create data export Webhook destination", + "description": "Create a Webhook destination with an Id.", + "parameters": { + "baseDomain": "azureiotcentral.com", + "subdomain": "appsubdomain", + "destinationId": "destination1", + "api-version": "1.1-preview", + "body": { + "displayName": "Webhook No Auth", + "type": "webhook@v1", + "url": "https://webhook.site/9bda8769-d540-4d92-946b-48c5a01e59bd", + "headerCustomizations": { + "x-custom-region": { + "value": "westcentralus", + "secret": false + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "destination1", + "displayName": "Webhook No Auth", + "type": "webhook@v1", + "url": "https://webhook.site/9bda8769-d540-4d92-946b-48c5a01e59bd", + "headerCustomizations": { + "x-custom-region": { + "value": "westcentralus", + "secret": false + } + }, + "status": "waiting" + } + } + } +} diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_destinations_delete.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_destinations_delete.json new file mode 100644 index 000000000000..1de306e3b487 --- /dev/null +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_destinations_delete.json @@ -0,0 +1,13 @@ +{ + "title": "Delete data export destination", + "description": "Delete a data export destination with Id.", + "parameters": { + "baseDomain": "azureiotcentral.com", + "subdomain": "appsubdomain", + "destinationId": "destination1", + "api-version": "1.1-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_destinations_exports_list.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_destinations_exports_list.json new file mode 100644 index 000000000000..b44d5372e464 --- /dev/null +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_destinations_exports_list.json @@ -0,0 +1,32 @@ +{ + "title": "List all data exports connected to the given destination", + "description": "Get a list of data exports connected to the given destination, returned exports include everything except the destination.", + "parameters": { + "baseDomain": "azureiotcentral.com", + "subdomain": "appsubdomain", + "api-version": "1.1-preview", + "destinationId": "destination1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "newTest", + "displayName": "Test Export 1", + "enabled": true, + "source": "telemetry", + "filter": "SELECT * FROM devices WHERE $displayName != \"abc\" AND $id = \"a\"", + "enrichments": { + "abc": { + "path": "$templateDisplayName" + } + }, + "destinations": [], + "status": "healthy" + } + ] + } + } + } +} diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_destinations_get.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_destinations_get.json new file mode 100644 index 000000000000..89cd1fbba408 --- /dev/null +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_destinations_get.json @@ -0,0 +1,33 @@ +{ + "title": "Get data export destination", + "description": "Get a data export destination with Id.", + "parameters": { + "baseDomain": "azureiotcentral.com", + "subdomain": "appsubdomain", + "destinationId": "destination1", + "api-version": "1.1-preview" + }, + "responses": { + "200": { + "body": { + "id": "1021f12a-6969-4eff-8518-57cac5f128ab", + "displayName": "Webhook No Auth", + "type": "webhook@v1", + "url": "https://webhook.site/9bda8769-d540-4d92-946b-48c5a01e59bd", + "headerCustomizations": { + "x-custom-region": { + "value": "westcentralus", + "secret": false + } + }, + "status": "error", + "errors": [ + { + "code": "InvalidResponse", + "message": "The webhook returned a 4xx status code." + } + ] + } + } + } +} diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_destinations_list.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_destinations_list.json new file mode 100644 index 000000000000..e777d670cd11 --- /dev/null +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_destinations_list.json @@ -0,0 +1,86 @@ +{ + "title": "List data export destinations in your application", + "description": "Get a list of data export destinations in your application.", + "parameters": { + "baseDomain": "azureiotcentral.com", + "subdomain": "appsubdomain", + "api-version": "1.1-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "1021f12a-6969-4eff-8518-57cac5f128ab", + "displayName": "Webhook No Auth", + "type": "webhook@v1", + "url": "https://webhook.site/9bda8769-d540-4d92-946b-48c5a01e59bd", + "headerCustomizations": { + "x-custom-region": { + "value": "westcentralus", + "secret": false + } + }, + "status": "waiting" + }, + { + "id": "70bb70e7-e308-4628-95aa-706596646f02", + "displayName": "Service Bus Queue", + "type": "servicebusqueue@v1", + "authorization": { + "type": "connectionString", + "connectionString": "Endpoint=sb://[namespace].servicebus.windows.net/;SharedAccessKeyName=xxx;SharedAccessKey=*****;EntityPath=[queue name]" + }, + "status": "waiting" + }, + { + "id": "7308456f-c72b-43d8-99ba-22a49ea5d51a", + "displayName": "Service Bus Topic", + "type": "servicebustopic@v1", + "authorization": { + "type": "connectionString", + "connectionString": "Endpoint=sb://[namespace].servicebus.windows.net/;SharedAccessKeyName=xxx;SharedAccessKey=*****;EntityPath=[topic name]" + }, + "status": "waiting" + }, + { + "id": "b3bfe8f0-ea63-42f9-82e1-bbade5250aba", + "displayName": "Azure Data Explorer", + "type": "dataexplorer@v1", + "clusterUrl": "https://[clusterName].westus2.kusto.windows.net", + "database": "iiot", + "table": "demo", + "authorization": { + "type": "servicePrincipal", + "clientId": "5b420743-2020-44c6-9b70-cc42f945db0c", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "clientSecret": "*****" + }, + "status": "waiting" + }, + { + "id": "beb083d0-cec9-4e7e-8e4b-22b88e8e3479", + "displayName": "Azure Blob Storage", + "type": "blobstorage@v1", + "authorization": { + "type": "connectionString", + "connectionString": "DefaultEndpointsProtocol=https;AccountName=[accountName];AccountKey=*****;EndpointSuffix=core.windows.net", + "containerName": "test" + }, + "status": "waiting" + }, + { + "id": "c0e2a49f-6d5b-4bc1-b448-069806b72781", + "displayName": "Event Hub", + "type": "eventhubs@v1", + "authorization": { + "type": "connectionString", + "connectionString": "Endpoint=sb://[namespace].servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=*****;EntityPath=[hub name]" + }, + "status": "waiting" + } + ] + } + } + } +} diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_destinations_update_webhook.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_destinations_update_webhook.json new file mode 100644 index 000000000000..18c8ad7066dd --- /dev/null +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_destinations_update_webhook.json @@ -0,0 +1,35 @@ +{ + "title": "Update data export Webhook destination", + "description": "Updatea Webhook destination with an Id.", + "parameters": { + "baseDomain": "azureiotcentral.com", + "subdomain": "appsubdomain", + "destinationId": "destination1", + "api-version": "1.1-preview", + "body": { + "headerCustomizations": { + "x-custom-region": { + "value": "eastus", + "secret": false + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "destination1", + "displayName": "Webhook No Auth", + "type": "webhook@v1", + "url": "https://webhook.site/9bda8769-d540-4d92-946b-48c5a01e59bd", + "headerCustomizations": { + "x-custom-region": { + "value": "eastus", + "secret": false + } + }, + "status": "waiting" + } + } + } +} diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_exports_create.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_exports_create.json new file mode 100644 index 000000000000..edf6508461ff --- /dev/null +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_exports_create.json @@ -0,0 +1,50 @@ +{ + "title": "Create a data export", + "description": "Create a data export with Id.", + "parameters": { + "baseDomain": "azureiotcentral.com", + "subdomain": "appsubdomain", + "exportId": "export1", + "api-version": "1.1-preview", + "body": { + "displayName": "Test Export 1", + "enabled": false, + "source": "telemetry", + "filter": "SELECT * FROM devices WHERE $displayName != \"abc\" AND $id = \"a\"", + "enrichments": { + "abc": { + "path": "$templateDisplayName" + } + }, + "destinations": [ + { + "id": "fa5792a4-ead3-41dc-a972-fbeed33d46ae", + "transform": "{ ApplicationId: .applicationId, Component: .component, DeviceName: .device.name }" + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "export1", + "displayName": "Test Export 1", + "enabled": false, + "source": "telemetry", + "filter": "SELECT * FROM devices WHERE $displayName != \"abc\" AND $id = \"a\"", + "enrichments": { + "abc": { + "path": "$templateDisplayName" + } + }, + "destinations": [ + { + "id": "fa5792a4-ead3-41dc-a972-fbeed33d46ae", + "transform": "{ ApplicationId: .applicationId, Component: .component, DeviceName: .device.name }" + } + ], + "status": "notStarted" + } + } + } +} diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_exports_delete.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_exports_delete.json new file mode 100644 index 000000000000..be9dbbd5212a --- /dev/null +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_exports_delete.json @@ -0,0 +1,13 @@ +{ + "title": "Delete a data export", + "description": "Delete a data export with Id.", + "parameters": { + "baseDomain": "azureiotcentral.com", + "subdomain": "appsubdomain", + "exportId": "export1", + "api-version": "1.1-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_exports_destinations_list.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_exports_destinations_list.json new file mode 100644 index 000000000000..a50cc5059043 --- /dev/null +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_exports_destinations_list.json @@ -0,0 +1,26 @@ +{ + "title": "List destinations defined in data export", + "description": "Get a list of destinations in your data export.", + "parameters": { + "baseDomain": "azureiotcentral.com", + "subdomain": "appsubdomain", + "api-version": "1.1-preview", + "exportId": "export1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "fa5792a4-ead3-41dc-a972-fbeed33d46ae", + "displayName": "Web Hook", + "type": "webhook@v1", + "url": "https://webhook.site/9bda8769-d540-4d92-946b-48c5a01e59bd", + "headerCustomizations": {}, + "status": "healthy" + } + ] + } + } + } +} diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_exports_get.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_exports_get.json new file mode 100644 index 000000000000..3b8facd0d5b2 --- /dev/null +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_exports_get.json @@ -0,0 +1,33 @@ +{ + "title": "Get a data export", + "description": "Get a data export with Id.", + "parameters": { + "baseDomain": "azureiotcentral.com", + "subdomain": "appsubdomain", + "exportId": "export1", + "api-version": "1.1-preview" + }, + "responses": { + "200": { + "body": { + "id": "export1", + "displayName": "Test Export 1", + "enabled": false, + "source": "telemetry", + "filter": "SELECT * FROM devices WHERE $displayName != \"abc\" AND $id = \"a\"", + "enrichments": { + "abc": { + "path": "$templateDisplayName" + } + }, + "destinations": [ + { + "id": "fa5792a4-ead3-41dc-a972-fbeed33d46ae", + "transform": "{ ApplicationId: .applicationId, Component: .component, DeviceName: .device.name }" + } + ], + "status": "notStarted" + } + } + } +} diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_exports_list.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_exports_list.json new file mode 100644 index 000000000000..29ab1f4097af --- /dev/null +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_exports_list.json @@ -0,0 +1,67 @@ +{ + "title": "List data exports in your application", + "description": "Get a list of data exports in your application.", + "parameters": { + "baseDomain": "azureiotcentral.com", + "subdomain": "appsubdomain", + "api-version": "1.1-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "export1", + "displayName": "Test Export 1", + "enabled": false, + "source": "telemetry", + "filter": "SELECT * FROM devices WHERE $displayName != \"abc\" AND $id = \"a\"", + "enrichments": { + "abc": { + "path": "$templateDisplayName" + } + }, + "destinations": [ + { + "id": "fa5792a4-ead3-41dc-a972-fbeed33d46ae", + "transform": "{ ApplicationId: .applicationId, Component: .component, DeviceName: .device.name }" + } + ], + "status": "notStarted" + }, + { + "id": "export2", + "displayName": "Test Export 2", + "enabled": true, + "source": "telemetry", + "filter": "SELECT * FROM devices WHERE $id == \"a\"", + "enrichments": { + "abc": { + "path": "$deviceName" + } + }, + "destinations": [ + { + "id": "fa5792a4-ead3-41dc-a972-fbeed33d46ae" + } + ], + "status": "starting" + }, + { + "id": "d7686dda-43d5-4e22-af4e-9518b0ebed29", + "displayName": "Test Export 3", + "enabled": true, + "source": "properties", + "filter": "SELECT * FROM devices WHERE CONTAINS($displayName, \"a\")", + "destinations": [ + { + "id": "destination1" + } + ], + "status": "healthy" + } + ] + } + } + } +} diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_exports_update.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_exports_update.json new file mode 100644 index 000000000000..e5024fed0936 --- /dev/null +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/dataexports_exports_update.json @@ -0,0 +1,42 @@ +{ + "title": "Update a data export", + "description": "Update a data export with Id.", + "parameters": { + "baseDomain": "azureiotcentral.com", + "subdomain": "appsubdomain", + "exportId": "export1", + "api-version": "1.1-preview", + "body": { + "displayName": "Test Export Update", + "enabled": true, + "enrichments": { + "abc": { + "path": "$provisioned" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "export1", + "displayName": "Test Export Update", + "enabled": true, + "source": "telemetry", + "filter": "SELECT * FROM devices WHERE $displayName != \"abc\" AND $id = \"a\"", + "enrichments": { + "abc": { + "path": "$provisioned" + } + }, + "destinations": [ + { + "id": "fa5792a4-ead3-41dc-a972-fbeed33d46ae", + "transform": "{ ApplicationId: .applicationId, Component: .component, DeviceName: .device.name }" + } + ], + "status": "starting" + } + } + } +} diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/devices_relationships_create.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/devices_relationships_create.json new file mode 100644 index 000000000000..edbbd3a1be67 --- /dev/null +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/devices_relationships_create.json @@ -0,0 +1,26 @@ +{ + "title": "Create a relationship between device", + "description": "Create a relationship with an Id.", + "parameters": { + "baseDomain": "azureiotcentral.com", + "subdomain": "appsubdomain", + "deviceId": "device1", + "relationshipId": "relationship1", + "api-version": "1.1-preview", + "body": { + "name": "Relationship1", + "source": "device1", + "target": "device2" + } + }, + "responses": { + "200": { + "body": { + "id": "relationship1", + "name": "Relationship1", + "source": "device1", + "target": "device2" + } + } + } +} diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/devices_relationships_delete.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/devices_relationships_delete.json new file mode 100644 index 000000000000..3059c326ba7d --- /dev/null +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/devices_relationships_delete.json @@ -0,0 +1,14 @@ +{ + "title": "Delete device relationship", + "description": "Delete a device relationship by Id.", + "parameters": { + "baseDomain": "azureiotcentral.com", + "subdomain": "appsubdomain", + "deviceId": "device1", + "relationshipId": "relationship1", + "api-version": "1.1-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/devices_relationships_get.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/devices_relationships_get.json new file mode 100644 index 000000000000..ddb237074a77 --- /dev/null +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/devices_relationships_get.json @@ -0,0 +1,21 @@ +{ + "title": "Get a relationship between device", + "description": "Get a relationship with an Id.", + "parameters": { + "baseDomain": "azureiotcentral.com", + "subdomain": "appsubdomain", + "deviceId": "device1", + "relationshipId": "relationship1", + "api-version": "1.1-preview" + }, + "responses": { + "200": { + "body": { + "id": "relationship1", + "name": "Relationship1", + "source": "device1", + "target": "device2" + } + } + } +} diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/devices_relationships_list.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/devices_relationships_list.json new file mode 100644 index 000000000000..3d9df231bc22 --- /dev/null +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/devices_relationships_list.json @@ -0,0 +1,36 @@ +{ + "title": "List device relationships", + "description": "List all relationships for your device.", + "parameters": { + "baseDomain": "azureiotcentral.com", + "subdomain": "appsubdomain", + "deviceId": "device1", + "api-version": "1.1-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "relationship1", + "name": "Relationship1", + "source": "device1", + "target": "device2" + }, + { + "id": "relationship2", + "name": "Relationship2", + "source": "device3", + "target": "device1" + }, + { + "id": "relationship3", + "name": "Relationship3", + "source": "device1", + "target": "device4" + } + ] + } + } + } +} diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/devices_relationships_update.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/devices_relationships_update.json new file mode 100644 index 000000000000..cf51f5f5a5f2 --- /dev/null +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/devices_relationships_update.json @@ -0,0 +1,24 @@ +{ + "title": "Update a relationship between device", + "description": "Update a relationship with an Id.", + "parameters": { + "baseDomain": "azureiotcentral.com", + "subdomain": "appsubdomain", + "deviceId": "device1", + "relationshipId": "relationship1", + "api-version": "1.1-preview", + "body": { + "target": "device3" + } + }, + "responses": { + "200": { + "body": { + "id": "relationship1", + "name": "Relationship1", + "source": "device1", + "target": "device3" + } + } + } +} diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/devicetemplates_create.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/devicetemplates_create.json index 1b78f2bda9ed..796afe6e7a0d 100644 --- a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/devicetemplates_create.json +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/devicetemplates_create.json @@ -172,6 +172,97 @@ "schema": "dateTime" } ] + }, + "deploymentManifest": { + "modulesContent": { + "$edgeAgent": { + "properties.desired": { + "schemaVersion": "1.1", + "runtime": { + "type": "docker", + "settings": { + "minDockerVersion": "v1.25", + "loggingOptions": "", + "registryCredentials": { + "ContosoRegistry": { + "username": "myacr", + "password": "", + "address": "myacr.azurecr.io" + } + } + } + }, + "systemModules": { + "edgeAgent": { + "type": "docker", + "settings": { + "image": "mcr.microsoft.com/azureiotedge-agent:1.1", + "createOptions": "{}" + } + }, + "edgeHub": { + "type": "docker", + "status": "running", + "restartPolicy": "always", + "startupOrder": 0, + "settings": { + "image": "mcr.microsoft.com/azureiotedge-hub:1.1", + "createOptions": "{\"HostConfig\":{\"PortBindings\":{\"443/tcp\":[{\"HostPort\":\"443\"}],\"5671/tcp\":[{\"HostPort\":\"5671\"}],\"8883/tcp\":[{\"HostPort\":\"8883\"}]}}}" + } + } + }, + "modules": { + "SimulatedTemperatureSensor": { + "version": "1.0", + "type": "docker", + "status": "running", + "restartPolicy": "always", + "startupOrder": 2, + "settings": { + "image": "mcr.microsoft.com/azureiotedge-simulated-temperature-sensor:1.0", + "createOptions": "{}" + } + }, + "testModule": { + "version": "1.0", + "type": "docker", + "status": "running", + "restartPolicy": "always", + "startupOrder": 1, + "env": { + "tempLimit": { + "value": "100" + } + }, + "settings": { + "image": "myacr.azurecr.io/testModule:latest", + "createOptions": "{}" + } + } + } + } + }, + "$edgeHub": { + "properties.desired": { + "schemaVersion": "1.1", + "routes": { + "sensorToFilter": { + "route": "FROM /messages/modules/SimulatedTemperatureSensor/outputs/temperatureOutput INTO BrokeredEndpoint(\"/modules/testModule/inputs/input1\")", + "priority": 0, + "timeToLiveSecs": 1800 + }, + "filterToIoTHub": { + "route": "FROM /messages/modules/testModule/outputs/output1 INTO $upstream", + "priority": 1, + "timeToLiveSecs": 1800 + } + }, + "storeAndForwardConfiguration": { + "timeToLiveSecs": 100 + } + } + } + } } } }, @@ -345,6 +436,97 @@ "schema": "dateTime" } ] + }, + "deploymentManifest": { + "modulesContent": { + "$edgeAgent": { + "properties.desired": { + "schemaVersion": "1.1", + "runtime": { + "type": "docker", + "settings": { + "minDockerVersion": "v1.25", + "loggingOptions": "", + "registryCredentials": { + "ContosoRegistry": { + "username": "myacr", + "password": "", + "address": "myacr.azurecr.io" + } + } + } + }, + "systemModules": { + "edgeAgent": { + "type": "docker", + "settings": { + "image": "mcr.microsoft.com/azureiotedge-agent:1.1", + "createOptions": "{}" + } + }, + "edgeHub": { + "type": "docker", + "status": "running", + "restartPolicy": "always", + "startupOrder": 0, + "settings": { + "image": "mcr.microsoft.com/azureiotedge-hub:1.1", + "createOptions": "{\"HostConfig\":{\"PortBindings\":{\"443/tcp\":[{\"HostPort\":\"443\"}],\"5671/tcp\":[{\"HostPort\":\"5671\"}],\"8883/tcp\":[{\"HostPort\":\"8883\"}]}}}" + } + } + }, + "modules": { + "SimulatedTemperatureSensor": { + "version": "1.0", + "type": "docker", + "status": "running", + "restartPolicy": "always", + "startupOrder": 2, + "settings": { + "image": "mcr.microsoft.com/azureiotedge-simulated-temperature-sensor:1.0", + "createOptions": "{}" + } + }, + "testModule": { + "version": "1.0", + "type": "docker", + "status": "running", + "restartPolicy": "always", + "startupOrder": 1, + "env": { + "tempLimit": { + "value": "100" + } + }, + "settings": { + "image": "myacr.azurecr.io/testModule:latest", + "createOptions": "{}" + } + } + } + } + }, + "$edgeHub": { + "properties.desired": { + "schemaVersion": "1.1", + "routes": { + "sensorToFilter": { + "route": "FROM /messages/modules/SimulatedTemperatureSensor/outputs/temperatureOutput INTO BrokeredEndpoint(\"/modules/testModule/inputs/input1\")", + "priority": 0, + "timeToLiveSecs": 1800 + }, + "filterToIoTHub": { + "route": "FROM /messages/modules/testModule/outputs/output1 INTO $upstream", + "priority": 1, + "timeToLiveSecs": 1800 + } + }, + "storeAndForwardConfiguration": { + "timeToLiveSecs": 100 + } + } + } + } } } } diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/devicetemplates_get.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/devicetemplates_get.json index 0f9bba02f678..b560f6e2e73b 100644 --- a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/devicetemplates_get.json +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/devicetemplates_get.json @@ -177,6 +177,97 @@ "schema": "dateTime" } ] + }, + "deploymentManifest": { + "modulesContent": { + "$edgeAgent": { + "properties.desired": { + "schemaVersion": "1.1", + "runtime": { + "type": "docker", + "settings": { + "minDockerVersion": "v1.25", + "loggingOptions": "", + "registryCredentials": { + "ContosoRegistry": { + "username": "myacr", + "password": "", + "address": "myacr.azurecr.io" + } + } + } + }, + "systemModules": { + "edgeAgent": { + "type": "docker", + "settings": { + "image": "mcr.microsoft.com/azureiotedge-agent:1.1", + "createOptions": "{}" + } + }, + "edgeHub": { + "type": "docker", + "status": "running", + "restartPolicy": "always", + "startupOrder": 0, + "settings": { + "image": "mcr.microsoft.com/azureiotedge-hub:1.1", + "createOptions": "{\"HostConfig\":{\"PortBindings\":{\"443/tcp\":[{\"HostPort\":\"443\"}],\"5671/tcp\":[{\"HostPort\":\"5671\"}],\"8883/tcp\":[{\"HostPort\":\"8883\"}]}}}" + } + } + }, + "modules": { + "SimulatedTemperatureSensor": { + "version": "1.0", + "type": "docker", + "status": "running", + "restartPolicy": "always", + "startupOrder": 2, + "settings": { + "image": "mcr.microsoft.com/azureiotedge-simulated-temperature-sensor:1.0", + "createOptions": "{}" + } + }, + "testModule": { + "version": "1.0", + "type": "docker", + "status": "running", + "restartPolicy": "always", + "startupOrder": 1, + "env": { + "tempLimit": { + "value": "100" + } + }, + "settings": { + "image": "myacr.azurecr.io/testModule:latest", + "createOptions": "{}" + } + } + } + } + }, + "$edgeHub": { + "properties.desired": { + "schemaVersion": "1.1", + "routes": { + "sensorToFilter": { + "route": "FROM /messages/modules/SimulatedTemperatureSensor/outputs/temperatureOutput INTO BrokeredEndpoint(\"/modules/testModule/inputs/input1\")", + "priority": 0, + "timeToLiveSecs": 1800 + }, + "filterToIoTHub": { + "route": "FROM /messages/modules/testModule/outputs/output1 INTO $upstream", + "priority": 1, + "timeToLiveSecs": 1800 + } + }, + "storeAndForwardConfiguration": { + "timeToLiveSecs": 100 + } + } + } + } } } } diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/devicetemplates_list.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/devicetemplates_list.json index 869589d04a80..54111c702361 100644 --- a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/devicetemplates_list.json +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/devicetemplates_list.json @@ -178,6 +178,97 @@ "schema": "dateTime" } ] + }, + "deploymentManifest": { + "modulesContent": { + "$edgeAgent": { + "properties.desired": { + "schemaVersion": "1.1", + "runtime": { + "type": "docker", + "settings": { + "minDockerVersion": "v1.25", + "loggingOptions": "", + "registryCredentials": { + "ContosoRegistry": { + "username": "myacr", + "password": "", + "address": "myacr.azurecr.io" + } + } + } + }, + "systemModules": { + "edgeAgent": { + "type": "docker", + "settings": { + "image": "mcr.microsoft.com/azureiotedge-agent:1.1", + "createOptions": "{}" + } + }, + "edgeHub": { + "type": "docker", + "status": "running", + "restartPolicy": "always", + "startupOrder": 0, + "settings": { + "image": "mcr.microsoft.com/azureiotedge-hub:1.1", + "createOptions": "{\"HostConfig\":{\"PortBindings\":{\"443/tcp\":[{\"HostPort\":\"443\"}],\"5671/tcp\":[{\"HostPort\":\"5671\"}],\"8883/tcp\":[{\"HostPort\":\"8883\"}]}}}" + } + } + }, + "modules": { + "SimulatedTemperatureSensor": { + "version": "1.0", + "type": "docker", + "status": "running", + "restartPolicy": "always", + "startupOrder": 2, + "settings": { + "image": "mcr.microsoft.com/azureiotedge-simulated-temperature-sensor:1.0", + "createOptions": "{}" + } + }, + "testModule": { + "version": "1.0", + "type": "docker", + "status": "running", + "restartPolicy": "always", + "startupOrder": 1, + "env": { + "tempLimit": { + "value": "100" + } + }, + "settings": { + "image": "myacr.azurecr.io/testModule:latest", + "createOptions": "{}" + } + } + } + } + }, + "$edgeHub": { + "properties.desired": { + "schemaVersion": "1.1", + "routes": { + "sensorToFilter": { + "route": "FROM /messages/modules/SimulatedTemperatureSensor/outputs/temperatureOutput INTO BrokeredEndpoint(\"/modules/testModule/inputs/input1\")", + "priority": 0, + "timeToLiveSecs": 1800 + }, + "filterToIoTHub": { + "route": "FROM /messages/modules/testModule/outputs/output1 INTO $upstream", + "priority": 1, + "timeToLiveSecs": 1800 + } + }, + "storeAndForwardConfiguration": { + "timeToLiveSecs": 100 + } + } + } + } } } ] diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/devicetemplates_update.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/devicetemplates_update.json new file mode 100644 index 000000000000..1f63237c04eb --- /dev/null +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/devicetemplates_update.json @@ -0,0 +1,352 @@ +{ + "title": "Update a device template", + "description": "Updates and publishes a device template.", + "parameters": { + "baseDomain": "azureiotcentral.com", + "subdomain": "appsubdomain", + "deviceTemplateId": "dtmi:contoso:testDeviceTemplate;1", + "api-version": "1.1-preview", + "body": { + "@type": [ + "ModelDefinition", + "DeviceModel", + "EdgeModel" + ], + "displayName": "Test Definition", + "capabilityModel": { + "@id": "dtmi:contoso:testCapabilityModel;1", + "@type": "Interface", + "displayName": "Test Capability Model", + "extends": [ + { + "@id": "dtmi:contoso:testInterface;1", + "@type": "Interface", + "displayName": "Test Interface", + "contents": [ + { + "@type": "Telemetry", + "displayName": "Test Telemetry", + "name": "testTelemetry", + "schema": "double" + }, + { + "@type": [ + "Telemetry", + "Event", + "EventValue" + ], + "displayName": "Test Event", + "name": "testEvent", + "schema": "integer", + "severity": "warning" + }, + { + "@type": [ + "Property", + "Initialized" + ], + "displayName": "Test Property", + "name": "testProperty", + "schema": "string", + "writable": true, + "initialValue": "initialValue1" + }, + { + "@type": "Property", + "displayName": "Test Read-Only Property", + "name": "testReadOnly", + "schema": "string" + }, + { + "@type": "Property", + "displayName": "Test Complex Property", + "name": "testComplex", + "schema": { + "@id": "dtmi:contoso:testComplex;1", + "@type": "Object", + "displayName": "Object", + "fields": [ + { + "displayName": "First", + "name": "first", + "schema": "string" + }, + { + "displayName": "Second", + "name": "second", + "schema": "string" + } + ] + }, + "writable": true + }, + { + "@type": "Command", + "commandType": "synchronous", + "displayName": "Test Command", + "name": "testCommand", + "request": { + "displayName": "Test Request", + "name": "testRequest", + "schema": "double" + }, + "response": { + "displayName": "Test Response", + "name": "testResponse", + "schema": "geopoint" + } + }, + { + "@type": "Property", + "displayName": "Test Enum", + "name": "testEnum", + "schema": { + "@id": "dtmi:contoso:testEnum;1", + "@type": "Enum", + "displayName": "Enum", + "enumValues": [ + { + "displayName": "First", + "enumValue": 1, + "name": "first" + }, + { + "displayName": "Second", + "enumValue": 2, + "name": "second" + } + ], + "valueSchema": "integer" + }, + "writable": true + } + ] + } + ], + "contents": [ + { + "@type": [ + "Relationship", + "EdgeModule" + ], + "displayName": "Test Module", + "maxMultiplicity": 1, + "name": "testModule", + "target": [ + { + "@id": "dtmi:contoso:testModuleCapabilityModel;1", + "@type": "Interface", + "displayName": "Test Module Capability Model", + "extends": [ + { + "@id": "dtmi:contoso:testModuleInterface;1", + "@type": "Interface", + "contents": [ + { + "@type": "Telemetry", + "displayName": "Test Module Telemetry", + "name": "testModuleTelemetry", + "schema": "double" + }, + { + "@type": "Property", + "displayName": "Test Module Property", + "name": "testModuleProperty", + "schema": "string", + "writable": true + } + ], + "displayName": "Test Module Interface" + } + ] + } + ] + }, + { + "@type": [ + "Cloud", + "Property" + ], + "displayName": "Test Cloud Property", + "name": "testCloudProperty", + "schema": "dateTime" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "@id": "dtmi:contoso:testDeviceTemplate;1", + "@type": [ + "ModelDefinition", + "DeviceModel", + "EdgeModel" + ], + "displayName": "Test Definition", + "etag": "\"~jbzfGhYctc9wtzNZXVmVua5JjTHO/FfjMUJvk9hqkRY=\"", + "capabilityModel": { + "@id": "dtmi:contoso:testCapabilityModel;1", + "@type": "Interface", + "displayName": "Test Capability Model", + "extends": [ + { + "@id": "dtmi:contoso:testInterface;1", + "@type": "Interface", + "displayName": "Test Interface", + "contents": [ + { + "@type": "Telemetry", + "displayName": "Test Telemetry", + "name": "testTelemetry", + "schema": "double" + }, + { + "@type": [ + "Telemetry", + "Event", + "EventValue" + ], + "displayName": "Test Event", + "name": "testEvent", + "schema": "integer", + "severity": "warning" + }, + { + "@type": [ + "Property", + "Initialized" + ], + "displayName": "Test Property", + "name": "testProperty", + "schema": "string", + "writable": true, + "initialValue": "initialValue1" + }, + { + "@type": "Property", + "displayName": "Test Read-Only Property", + "name": "testReadOnly", + "schema": "string" + }, + { + "@type": "Property", + "displayName": "Test Complex Property", + "name": "testComplex", + "schema": { + "@id": "dtmi:contoso:testComplex;1", + "@type": "Object", + "displayName": "Object", + "fields": [ + { + "displayName": "First", + "name": "first", + "schema": "string" + }, + { + "displayName": "Second", + "name": "second", + "schema": "string" + } + ] + }, + "writable": true + }, + { + "@type": "Command", + "commandType": "synchronous", + "displayName": "Test Command", + "name": "testCommand", + "request": { + "displayName": "Test Request", + "name": "testRequest", + "schema": "double" + }, + "response": { + "displayName": "Test Response", + "name": "testResponse", + "schema": "geopoint" + } + }, + { + "@type": "Property", + "displayName": "Test Enum", + "name": "testEnum", + "schema": { + "@id": "dtmi:contoso:testEnum;1", + "@type": "Enum", + "displayName": "Enum", + "enumValues": [ + { + "displayName": "First", + "enumValue": 1, + "name": "first" + }, + { + "displayName": "Second", + "enumValue": 2, + "name": "second" + } + ], + "valueSchema": "integer" + }, + "writable": true + } + ] + } + ], + "contents": [ + { + "@type": [ + "Relationship", + "EdgeModule" + ], + "displayName": "Test Module", + "maxMultiplicity": 1, + "name": "testModule", + "target": [ + { + "@id": "dtmi:contoso:testModuleCapabilityModel;1", + "@type": "Interface", + "displayName": "Test Module Capability Model", + "extends": [ + { + "@id": "dtmi:contoso:testModuleInterface;1", + "@type": "Interface", + "contents": [ + { + "@type": "Telemetry", + "displayName": "Test Module Telemetry", + "name": "testModuleTelemetry", + "schema": "double" + }, + { + "@type": "Property", + "displayName": "Test Module Property", + "name": "testModuleProperty", + "schema": "string", + "writable": true + } + ], + "displayName": "Test Module Interface" + } + ] + } + ] + }, + { + "@type": [ + "Cloud", + "Property" + ], + "displayName": "Test Cloud Property", + "name": "testCloudProperty", + "schema": "dateTime" + } + ] + } + } + } + } +} diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/fileUpload_get.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/fileUpload_get.json index 8c92cf9cead7..f8b252909c54 100644 --- a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/fileUpload_get.json +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/fileUpload_get.json @@ -12,7 +12,6 @@ "account": "contoso-account", "connectionString": "DefaultEndpointsProtocol=https;AccountName=MyAccountName;AccountKey=*****;EndpointSuffix=core.windows.net", "container": "container", - "sasTtl": "PT2H", "state": "succeeded" } } diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/query_run.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/query_run.json new file mode 100644 index 000000000000..f8dbf4c8310d --- /dev/null +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/examples/query_run.json @@ -0,0 +1,65 @@ +{ + "title": "Query telemetry", + "description": "Telemetry Query with Aggregation", + "parameters": { + "baseDomain": "azureiotcentral.com", + "subdomain": "appsubdomain", + "api-version": "1.1-preview", + "body": { + "query": "SELECT AVG(RootTelemetry), MAX(RootTelemetry) FROM dtmi:modelDefinition:y5zk2yqblv:en9xfxjif WHERE WITHIN_WINDOW(P1D) AND RootTelemetry > 0 GROUP BY WINDOW(PT3H) ORDER BY $ts ASC" + } + }, + "responses": { + "200": { + "body": { + "results": [ + { + "$ts": "2021-07-13T15:00:00Z", + "avg_RootTelemetry": 50.694243369718016, + "max_RootTelemetry": 94.84065276149875 + }, + { + "$ts": "2021-07-13T18:00:00Z", + "avg_RootTelemetry": 50.18217245036151, + "max_RootTelemetry": 94.06959391609293 + }, + { + "$ts": "2021-07-13T21:00:00Z", + "avg_RootTelemetry": 49.146167597153536, + "max_RootTelemetry": 92.23986369686345 + }, + { + "$ts": "2021-07-14T00:00:00Z", + "avg_RootTelemetry": 50.175258720781486, + "max_RootTelemetry": 93.635346493204 + }, + { + "$ts": "2021-07-14T03:00:00Z", + "avg_RootTelemetry": 49.89615329936023, + "max_RootTelemetry": 97.06116727704713 + }, + { + "$ts": "2021-07-14T06:00:00Z", + "avg_RootTelemetry": 50.45104017085097, + "max_RootTelemetry": 97.62388863622462 + }, + { + "$ts": "2021-07-14T09:00:00Z", + "avg_RootTelemetry": 50.256835113864774, + "max_RootTelemetry": 97.920784666869 + }, + { + "$ts": "2021-07-14T12:00:00Z", + "avg_RootTelemetry": 49.68389289395193, + "max_RootTelemetry": 97.33361905646282 + }, + { + "$ts": "2021-07-14T15:00:00Z", + "avg_RootTelemetry": 50.27084162154068, + "max_RootTelemetry": 94.65114410748755 + } + ] + } + } + } +} diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/iotcentral.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/iotcentral.json index 9c40c8f5961f..549de12aba5d 100644 --- a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/iotcentral.json +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/1.1-preview/iotcentral.json @@ -107,6 +107,82 @@ ], "discriminator": "type" }, + "BlobStorageV1Destination": { + "x-ms-discriminator-value": "blobstorage@v1", + "allOf": [ + { + "$ref": "#/definitions/Destination" + } + ], + "type": "object", + "properties": { + "authorization": { + "$ref": "#/definitions/BlobStorageV1DestinationAuth" + } + }, + "required": [ + "authorization" + ] + }, + "BlobStorageV1DestinationAuth": { + "type": "object", + "properties": { + "type": { + "description": "The kind of authentication to use.", + "type": "string" + } + }, + "required": [ + "type" + ], + "discriminator": "type" + }, + "BlobStorageV1DestinationConnectionStringAuth": { + "x-ms-discriminator-value": "connectionString", + "allOf": [ + { + "$ref": "#/definitions/BlobStorageV1DestinationAuth" + } + ], + "type": "object", + "properties": { + "connectionString": { + "description": "The connection string for accessing the blob storage account.", + "type": "string" + }, + "containerName": { + "description": "Name of the container where data should be written in the storage account.", + "type": "string" + } + }, + "required": [ + "connectionString", + "containerName" + ] + }, + "BlobStorageV1DestinationSystemAssignedManagedIdentityAuth": { + "x-ms-discriminator-value": "systemAssignedManagedIdentity", + "allOf": [ + { + "$ref": "#/definitions/BlobStorageV1DestinationAuth" + } + ], + "type": "object", + "properties": { + "endpointUri": { + "description": "The storage account's blob service endpoint URL.", + "type": "string" + }, + "containerName": { + "description": "Name of the container where data should be written in the storage account.", + "type": "string" + } + }, + "required": [ + "endpointUri", + "containerName" + ] + }, "CloudPropertyJobData": { "x-ms-discriminator-value": "cloudProperty", "allOf": [ @@ -142,6 +218,181 @@ } ] }, + "DataExplorerV1Destination": { + "x-ms-discriminator-value": "dataexplorer@v1", + "allOf": [ + { + "$ref": "#/definitions/Destination" + } + ], + "type": "object", + "properties": { + "clusterUrl": { + "description": "The resource URI of the Data Explorer instance.", + "type": "string" + }, + "database": { + "description": "Name Data Explorer database where data should be written.", + "type": "string" + }, + "table": { + "description": "The table within the Data Explorer database that will receive the data.", + "type": "string" + }, + "authorization": { + "$ref": "#/definitions/DataExplorerV1DestinationAuth" + } + }, + "required": [ + "clusterUrl", + "database", + "table", + "authorization" + ] + }, + "DataExplorerV1DestinationAuth": { + "type": "object", + "properties": { + "type": { + "description": "The kind of authentication to use.", + "type": "string" + } + }, + "required": [ + "type" + ], + "discriminator": "type" + }, + "DataExplorerV1DestinationServicePrincipalAuth": { + "x-ms-discriminator-value": "servicePrincipal", + "allOf": [ + { + "$ref": "#/definitions/DataExplorerV1DestinationAuth" + } + ], + "type": "object", + "properties": { + "clientId": { + "description": "Service Principal client ID.", + "type": "string" + }, + "tenantId": { + "description": "Service Principal tenant ID.", + "type": "string" + }, + "clientSecret": { + "description": "Service Principal client secret.", + "type": "string" + } + }, + "required": [ + "clientId", + "tenantId", + "clientSecret" + ] + }, + "DataExportError": { + "type": "object", + "properties": { + "code": { + "description": "The code for the error that occurred.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "The description of the error that occurred.", + "type": "string", + "readOnly": true + } + } + }, + "DataExportStatus": { + "type": "object", + "properties": { + "status": { + "description": "Indication of the current health and operation of the export or destination.", + "type": "string", + "readOnly": true + }, + "errors": { + "description": "Errors encountered by the export or destination.", + "type": "array", + "items": { + "$ref": "#/definitions/DataExportError" + }, + "readOnly": true + }, + "lastExportTime": { + "description": "The timestamp of the last message that was sent to the export or destination.", + "type": "string", + "format": "date-time", + "readOnly": true + } + } + }, + "Destination": { + "allOf": [ + { + "$ref": "#/definitions/DataExportStatus" + } + ], + "type": "object", + "properties": { + "id": { + "description": "Unique ID of the destination.", + "type": "string", + "readOnly": true + }, + "displayName": { + "description": "Display name of the destination.", + "type": "string" + }, + "type": { + "description": "The type of destination configuration.", + "type": "string" + } + }, + "required": [ + "displayName", + "type" + ], + "discriminator": "type" + }, + "DestinationCollection": { + "type": "object", + "properties": { + "value": { + "description": "The collection of destinations.", + "type": "array", + "items": { + "$ref": "#/definitions/Destination" + } + }, + "nextLink": { + "description": "URL to get the next page of destinations.", + "type": "string" + } + }, + "required": [ + "value" + ] + }, + "DestinationReference": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The ID of the destination where data should be sent." + }, + "transform": { + "type": "string", + "description": "Query for transforming the message structure to a particular output." + } + }, + "required": [ + "id" + ] + }, "Device": { "type": "object", "properties": { @@ -327,6 +578,48 @@ "type": "object", "additionalProperties": true }, + "DeviceRelationship": { + "type": "object", + "description": "An object representing the relationship between an upstream and a downstream device.", + "properties": { + "id": { + "description": "The unique identifier of this relationship.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name which describes this relationship between given devices from source device template.", + "type": "string" + }, + "source": { + "description": "The device ID of the source (parent) device.", + "type": "string" + }, + "target": { + "description": "The device ID of the target (child) device.", + "type": "string" + } + } + }, + "DeviceRelationshipCollection": { + "type": "object", + "properties": { + "value": { + "description": "The collection of device relationships.", + "type": "array", + "items": { + "$ref": "#/definitions/DeviceRelationship" + } + }, + "nextLink": { + "description": "URL to get the next page of device relationships.", + "type": "string" + } + }, + "required": [ + "value" + ] + }, "DeviceTelemetry": { "type": "object", "properties": { @@ -370,6 +663,10 @@ "capabilityModel": { "description": "The capability model utilized by this device template.", "type": "object" + }, + "deploymentManifest": { + "description": "Deployment manifest associated to this device template.", + "type": "object" } }, "required": [ @@ -415,32 +712,227 @@ "email" ] }, - "FileUpload": { + "Enrichment": { "type": "object", "properties": { - "account": { - "description": "The storage account name where to upload the file to", + "target": { + "description": "The device template or interface which defines the target capability for the enrichment.", "type": "string" }, - "connectionString": { - "description": "The connection string used to configure the storage account", + "path": { + "description": "The path to the target capability within the device template or the system property to use.", "type": "string" }, - "container": { - "description": "The name of the container inside the storage account", + "value": { + "description": "The raw value used for the enrichment." + } + } + }, + "EventHubsV1Destination": { + "x-ms-discriminator-value": "eventhubs@v1", + "allOf": [ + { + "$ref": "#/definitions/Destination" + } + ], + "type": "object", + "properties": { + "authorization": { + "$ref": "#/definitions/EventHubsV1DestinationAuth" + } + }, + "required": [ + "authorization" + ] + }, + "EventHubsV1DestinationAuth": { + "type": "object", + "properties": { + "type": { + "description": "The kind of authentication to use.", "type": "string" - }, - "sasTtl": { - "description": "ISO 8601 duration standard, The amount of time the device’s request to upload a file is valid before it expires.​", + } + }, + "required": [ + "type" + ], + "discriminator": "type" + }, + "EventHubsV1DestinationConnectionStringAuth": { + "x-ms-discriminator-value": "connectionString", + "allOf": [ + { + "$ref": "#/definitions/EventHubsV1DestinationAuth" + } + ], + "type": "object", + "properties": { + "connectionString": { + "description": "The connection string for accessing the Event Hubs namespace, including the `EntityPath` of the event hub.", "type": "string" - }, - "state": { - "description": "The state of the file upload configuration", - "type": "string", - "readOnly": true, - "enum": [ - "pending", - "updating", + } + }, + "required": [ + "connectionString" + ] + }, + "EventHubsV1DestinationSystemAssignedManagedIdentityAuth": { + "x-ms-discriminator-value": "systemAssignedManagedIdentity", + "allOf": [ + { + "$ref": "#/definitions/EventHubsV1DestinationAuth" + } + ], + "type": "object", + "properties": { + "hostName": { + "description": "The host name of the Event Hubs namespace.", + "type": "string" + }, + "eventHubName": { + "description": "The Event Hubs instance name.", + "type": "string" + } + }, + "required": [ + "hostName", + "eventHubName" + ] + }, + "Export": { + "allOf": [ + { + "$ref": "#/definitions/DataExportStatus" + } + ], + "type": "object", + "properties": { + "id": { + "description": "Unique ID of the export.", + "type": "string", + "readOnly": true + }, + "displayName": { + "description": "Display name of the export.", + "type": "string" + }, + "enabled": { + "description": "Toggle to start/stop an export from sending data.", + "type": "boolean" + }, + "source": { + "description": "The type of data to export.", + "type": "string", + "enum": [ + "telemetry", + "properties", + "deviceLifecycle", + "deviceTemplateLifecycle", + "deviceConnectivity" + ], + "x-ms-enum": { + "name": "DestinationSource", + "modelAsString": false, + "values": [ + { + "value": "telemetry", + "name": "Telemetry", + "description": "Destination source from device telemetry" + }, + { + "value": "properties", + "name": "Properties", + "description": "Destination source from device properties" + }, + { + "value": "deviceLifecycle", + "name": "DeviceLifecycle", + "description": "Destination source from device lifecycle" + }, + { + "value": "deviceTemplateLifecycle", + "name": "DeviceTemplateLifecycle", + "description": "Destination source from device template lifecycle" + }, + { + "value": "deviceConnectivity", + "name": "DeviceConnectivity", + "description": "Destination source from device connectivity" + } + ] + } + }, + "filter": { + "description": "Query defining which events from the source should be exported.", + "type": "string" + }, + "enrichments": { + "description": "Additional pieces of information to include with each sent message. Data is represented as a set of key/value pairs, where the key is the name of the enrichment that will appear in the output message and the value identifies the data to send.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/Enrichment" + } + }, + "destinations": { + "description": "The list of destinations to which the export should send data.", + "type": "array", + "items": { + "$ref": "#/definitions/DestinationReference" + } + } + }, + "required": [ + "displayName", + "enabled", + "source", + "destinations" + ] + }, + "ExportCollection": { + "type": "object", + "properties": { + "value": { + "description": "The collection of exports.", + "type": "array", + "items": { + "$ref": "#/definitions/Export" + } + }, + "nextLink": { + "description": "URL to get the next page of exports.", + "type": "string" + } + }, + "required": [ + "value" + ] + }, + "FileUpload": { + "type": "object", + "properties": { + "account": { + "description": "The storage account name where to upload the file to", + "type": "string" + }, + "connectionString": { + "description": "The connection string used to configure the storage account", + "type": "string" + }, + "container": { + "description": "The name of the container inside the storage account", + "type": "string" + }, + "sasTtl": { + "description": "ISO 8601 duration standard, The amount of time the device’s request to upload a file is valid before it expires.", + "type": "string" + }, + "state": { + "description": "The state of the file upload configuration", + "type": "string", + "readOnly": true, + "enum": [ + "pending", + "updating", "deleting", "succeeded", "failed" @@ -522,6 +1014,15 @@ "description": "Indicates whether the job is starting, running, etc.", "type": "string", "readOnly": true + }, + "organizations": { + "description": "List of organizations of the job.", + "type": "array", + "items": { + "type": "string" + }, + "minItems": 1, + "maxItems": 1 } }, "required": [ @@ -746,6 +1247,32 @@ } ] }, + "QueryRequest": { + "type": "object", + "properties": { + "query": { + "description": "Query to be executed.", + "type": "string" + } + }, + "required": [ + "query" + ] + }, + "QueryResponse": { + "type": "object", + "properties": { + "results": { + "type": "array", + "items": { + "type": "object" + } + } + }, + "required": [ + "results" + ] + }, "Role": { "type": "object", "properties": { @@ -795,6 +1322,148 @@ "value" ] }, + "ServiceBusQueueV1Destination": { + "x-ms-discriminator-value": "servicebusqueue@v1", + "allOf": [ + { + "$ref": "#/definitions/Destination" + } + ], + "type": "object", + "properties": { + "authorization": { + "$ref": "#/definitions/ServiceBusQueueV1DestinationAuth" + } + }, + "required": [ + "authorization" + ] + }, + "ServiceBusQueueV1DestinationAuth": { + "type": "object", + "properties": { + "type": { + "description": "The kind of authentication to use.", + "type": "string" + } + }, + "required": [ + "type" + ], + "discriminator": "type" + }, + "ServiceBusQueueV1DestinationConnectionStringAuth": { + "x-ms-discriminator-value": "connectionString", + "allOf": [ + { + "$ref": "#/definitions/ServiceBusQueueV1DestinationAuth" + } + ], + "type": "object", + "properties": { + "connectionString": { + "description": "The connection string for accessing the Service Bus namespace, including the `EntityPath` of the queue.", + "type": "string" + } + }, + "required": [ + "connectionString" + ] + }, + "ServiceBusQueueV1DestinationSystemAssignedManagedIdentityAuth": { + "x-ms-discriminator-value": "systemAssignedManagedIdentity", + "allOf": [ + { + "$ref": "#/definitions/ServiceBusQueueV1DestinationAuth" + } + ], + "type": "object", + "properties": { + "hostName": { + "description": "The host name of the Service Bus namespace.", + "type": "string" + }, + "queueName": { + "description": "The Service Bus queue name.", + "type": "string" + } + }, + "required": [ + "hostName", + "queueName" + ] + }, + "ServiceBusTopicV1Destination": { + "x-ms-discriminator-value": "servicebustopic@v1", + "allOf": [ + { + "$ref": "#/definitions/Destination" + } + ], + "type": "object", + "properties": { + "authorization": { + "$ref": "#/definitions/ServiceBusTopicV1DestinationAuth" + } + }, + "required": [ + "authorization" + ] + }, + "ServiceBusTopicV1DestinationAuth": { + "type": "object", + "properties": { + "type": { + "description": "The kind of authentication to use.", + "type": "string" + } + }, + "required": [ + "type" + ], + "discriminator": "type" + }, + "ServiceBusTopicV1DestinationConnectionStringAuth": { + "x-ms-discriminator-value": "connectionString", + "allOf": [ + { + "$ref": "#/definitions/ServiceBusTopicV1DestinationAuth" + } + ], + "type": "object", + "properties": { + "connectionString": { + "description": "The connection string for accessing the Service Bus namespace, including the `EntityPath` of the topic.", + "type": "string" + } + }, + "required": [ + "connectionString" + ] + }, + "ServiceBusTopicV1DestinationSystemAssignedManagedIdentityAuth": { + "x-ms-discriminator-value": "systemAssignedManagedIdentity", + "allOf": [ + { + "$ref": "#/definitions/ServiceBusTopicV1DestinationAuth" + } + ], + "type": "object", + "properties": { + "hostName": { + "description": "The host name of the Service Bus namespace.", + "type": "string" + }, + "topicName": { + "description": "The Service Bus topic name.", + "type": "string" + } + }, + "required": [ + "hostName", + "topicName" + ] + }, "ServicePrincipalUser": { "x-ms-discriminator-value": "servicePrincipal", "allOf": [ @@ -925,38 +1594,186 @@ "value" ] }, - "X509": { - "type": "object", - "properties": { - "clientCertificates": { - "description": "The X.509 client certificates for this credential.", - "$ref": "#/definitions/X509Certificates" - } - } - }, - "X509Attestation": { - "x-ms-discriminator-value": "x509", + "WebhookV1Destination": { + "x-ms-discriminator-value": "webhook@v1", "allOf": [ { - "$ref": "#/definitions/Attestation" + "$ref": "#/definitions/Destination" } ], "type": "object", "properties": { - "x509": { - "description": "The X.509 credentials for this attestation.", - "$ref": "#/definitions/X509" + "url": { + "description": "The URL to invoke when exporting data.", + "type": "string" + }, + "queryCustomizations": { + "description": "Additional query parameters that should be added to each request.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/WebhookV1DestinationCustomization" + } + }, + "headerCustomizations": { + "description": "Additional headers that should be added to each request.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/WebhookV1DestinationCustomization" + } + }, + "authorization": { + "$ref": "#/definitions/WebhookV1DestinationAuth" } }, "required": [ - "x509" + "url" ] }, - "X509Certificate": { + "WebhookV1DestinationAuth": { "type": "object", "properties": { - "certificate": { - "description": "The string representation of this certificate.", + "type": { + "description": "The kind of authentication to use.", + "type": "string" + } + }, + "required": [ + "type" + ], + "discriminator": "type" + }, + "WebhookV1DestinationCustomization": { + "type": "object", + "properties": { + "value": { + "description": "The value to use for this webhook customization.", + "type": "string" + }, + "secret": { + "description": "Whether to consider the value to be a secret and hide it when retrieving the destination configuration.", + "type": "boolean" + } + }, + "required": [ + "value" + ] + }, + "WebhookV1DestinationHeaderAuth": { + "x-ms-discriminator-value": "header", + "allOf": [ + { + "$ref": "#/definitions/WebhookV1DestinationAuth" + } + ], + "type": "object", + "properties": { + "value": { + "description": "Value to use for the Authorization header when making requests.", + "type": "string" + } + }, + "required": [ + "value" + ] + }, + "WebhookV1DestinationOAuthAuth": { + "x-ms-discriminator-value": "oauth", + "allOf": [ + { + "$ref": "#/definitions/WebhookV1DestinationAuth" + } + ], + "type": "object", + "properties": { + "tokenUrl": { + "description": "URL where an access token can be retrieved.", + "type": "string" + }, + "clientId": { + "description": "OAuth2 client ID used when retrieving the token.", + "type": "string" + }, + "clientSecret": { + "description": "OAuth2 client secret used to retrieve the token.", + "type": "string" + }, + "audience": { + "description": "OAuth2 audience.", + "type": "string" + }, + "scope": { + "description": "OAuth2 scope.", + "type": "string" + }, + "requestType": { + "description": "Content-Type for the token request.", + "type": "string", + "enum": [ + "auto", + "json", + "urlencoded" + ], + "x-ms-enum": { + "name": "OAuthRequestType", + "modelAsString": false, + "values": [ + { + "value": "auto", + "name": "Auto", + "description": "Use automatic Content-Type for token request" + }, + { + "value": "json", + "name": "Json", + "description": "Content-Type as JSON for token request" + }, + { + "value": "urlencoded", + "name": "UrlEncoded", + "description": "Content-Type as UrlEncoded for token request" + } + ] + } + } + }, + "required": [ + "tokenUrl", + "clientId", + "clientSecret" + ] + }, + "X509": { + "type": "object", + "properties": { + "clientCertificates": { + "description": "The X.509 client certificates for this credential.", + "$ref": "#/definitions/X509Certificates" + } + } + }, + "X509Attestation": { + "x-ms-discriminator-value": "x509", + "allOf": [ + { + "$ref": "#/definitions/Attestation" + } + ], + "type": "object", + "properties": { + "x509": { + "description": "The X.509 credentials for this attestation.", + "$ref": "#/definitions/X509" + } + }, + "required": [ + "x509" + ] + }, + "X509Certificate": { + "type": "object", + "properties": { + "certificate": { + "description": "The string representation of this certificate.", "type": "string" }, "info": { @@ -1028,8 +1845,351 @@ "operationId": "ApiTokens_Get", "summary": "Get an API token by ID.", "x-ms-examples": { - "Get API token by ID": { - "$ref": "./examples/apitoken_get.json" + "Get API token by ID": { + "$ref": "./examples/apitoken_get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/Version" + }, + { + "in": "path", + "name": "tokenId", + "description": "Unique ID for the API token.", + "type": "string", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ApiToken" + } + } + } + }, + "put": { + "operationId": "ApiTokens_Create", + "summary": "Create a new API token in the application to use in the IoT Central public API. The token value will be returned in the response, and won't be returned again in subsequent requests.", + "x-ms-examples": { + "Create API token": { + "$ref": "./examples/apitoken_create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/Version" + }, + { + "in": "path", + "name": "tokenId", + "description": "Unique ID for the API token.", + "type": "string", + "required": true + }, + { + "in": "body", + "name": "body", + "description": "API token body.", + "schema": { + "$ref": "#/definitions/ApiToken" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ApiToken" + } + } + } + }, + "delete": { + "operationId": "ApiTokens_Remove", + "summary": "Delete an API token.", + "x-ms-examples": { + "Delete API token": { + "$ref": "./examples/apitoken_delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/Version" + }, + { + "in": "path", + "name": "tokenId", + "description": "Unique ID for the API token.", + "type": "string", + "required": true + } + ], + "responses": { + "204": { + "description": "Success" + } + } + } + }, + "/dataExport/destinations": { + "get": { + "operationId": "Destinations_List", + "summary": "Get the list of destinations in an application.", + "x-ms-examples": { + "List data export destinations": { + "$ref": "./examples/dataexports_destinations_list.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/Version" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DestinationCollection" + } + } + } + } + }, + "/dataExport/destinations/{destinationId}": { + "get": { + "operationId": "Destinations_Get", + "summary": "Get a destination by ID.", + "x-ms-examples": { + "Get a data export destination": { + "$ref": "./examples/dataexports_destinations_get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/Version" + }, + { + "$ref": "#/parameters/DestinationId" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Destination" + } + } + } + }, + "put": { + "operationId": "Destinations_Create", + "summary": "Create or update a destination", + "description": "Create or update a definition for where to send data.", + "x-ms-examples": { + "Create a webhook destination": { + "$ref": "./examples/dataexports_destinations_create_webhook.json" + }, + "Create an azure blob storage destination": { + "$ref": "./examples/dataexports_destinations_create_blob.json" + }, + "Create an azure data explorer destination": { + "$ref": "./examples/dataexports_destinations_create_adx.json" + }, + "Create an azure event hub destination": { + "$ref": "./examples/dataexports_destinations_create_eventhub.json" + }, + "Create an azure service bus queue destination": { + "$ref": "./examples/dataexports_destinations_create_queue.json" + }, + "Create an azure service bus topic destination": { + "$ref": "./examples/dataexports_destinations_create_topic.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/Version" + }, + { + "$ref": "#/parameters/DestinationId" + }, + { + "in": "body", + "name": "body", + "description": "Destination body.", + "schema": { + "$ref": "#/definitions/Destination" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Destination" + } + } + } + }, + "patch": { + "operationId": "Destinations_Update", + "summary": "Patch a destination.", + "description": "Perform an incremental update to a destination.", + "x-ms-examples": { + "Update an webhook destination": { + "$ref": "./examples/dataexports_destinations_update_webhook.json" + } + }, + "consumes": [ + "application/json", + "application/json-patch+json" + ], + "parameters": [ + { + "$ref": "#/parameters/Version" + }, + { + "$ref": "#/parameters/DestinationId" + }, + { + "in": "body", + "name": "body", + "description": "Destination patch body.", + "schema": { + "type": "object" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Destination" + } + } + } + }, + "delete": { + "operationId": "Destinations_Remove", + "summary": "Delete a destination.", + "x-ms-examples": { + "Delete data export destination": { + "$ref": "./examples/dataexports_destinations_delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/Version" + }, + { + "$ref": "#/parameters/DestinationId" + } + ], + "responses": { + "204": { + "description": "Success" + } + } + } + }, + "/dataExport/destinations/{destinationId}/exports": { + "get": { + "operationId": "Destinations_ListExports", + "summary": "List all exports connected to the given destination.", + "x-ms-examples": { + "List all exports connected to the given destination": { + "$ref": "./examples/dataexports_destinations_exports_list.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/Version" + }, + { + "$ref": "#/parameters/DestinationId" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ExportCollection" + } + } + } + } + }, + "/dataExport/exports": { + "get": { + "operationId": "Exports_List", + "summary": "Get the list of exports in an application.", + "x-ms-examples": { + "List data exports": { + "$ref": "./examples/dataexports_exports_list.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/Version" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ExportCollection" + } + } + } + } + }, + "/dataExport/exports/{exportId}": { + "get": { + "operationId": "Exports_Get", + "summary": "Get an export by ID.", + "x-ms-examples": { + "Get data export by ID": { + "$ref": "./examples/dataexports_exports_get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/Version" + }, + { + "$ref": "#/parameters/ExportId" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Export" + } + } + } + }, + "put": { + "operationId": "Exports_Create", + "summary": "Create or update an export", + "description": "Create or update a definition for exporting data. Also used to connect or disconnect an export from destinations.", + "x-ms-examples": { + "Create data export with ID": { + "$ref": "./examples/dataexports_exports_create.json" } }, "parameters": [ @@ -1037,10 +2197,15 @@ "$ref": "#/parameters/Version" }, { - "in": "path", - "name": "tokenId", - "description": "Unique ID for the API token.", - "type": "string", + "$ref": "#/parameters/ExportId" + }, + { + "in": "body", + "name": "body", + "description": "Export body.", + "schema": { + "$ref": "#/definitions/Export" + }, "required": true } ], @@ -1048,36 +2213,37 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ApiToken" + "$ref": "#/definitions/Export" } } } }, - "put": { - "operationId": "ApiTokens_Create", - "summary": "Create a new API token in the application to use in the IoT Central public API. The token value will be returned in the response, and won't be returned again in subsequent requests.", + "patch": { + "operationId": "Exports_Update", + "summary": "Patch an export.", + "description": "Perform an incremental update to an export.", "x-ms-examples": { - "Create API token": { - "$ref": "./examples/apitoken_create.json" + "Update a data export": { + "$ref": "./examples/dataexports_exports_update.json" } }, + "consumes": [ + "application/json", + "application/json-patch+json" + ], "parameters": [ { "$ref": "#/parameters/Version" }, { - "in": "path", - "name": "tokenId", - "description": "Unique ID for the API token.", - "type": "string", - "required": true + "$ref": "#/parameters/ExportId" }, { "in": "body", "name": "body", - "description": "API token body.", + "description": "Export patch body.", "schema": { - "$ref": "#/definitions/ApiToken" + "type": "object" }, "required": true } @@ -1086,17 +2252,17 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ApiToken" + "$ref": "#/definitions/Export" } } } }, "delete": { - "operationId": "ApiTokens_Remove", - "summary": "Delete an API token.", + "operationId": "Exports_Remove", + "summary": "Delete an export.", "x-ms-examples": { - "Delete API token": { - "$ref": "./examples/apitoken_delete.json" + "Delete a data export with ID": { + "$ref": "./examples/dataexports_exports_delete.json" } }, "parameters": [ @@ -1104,11 +2270,7 @@ "$ref": "#/parameters/Version" }, { - "in": "path", - "name": "tokenId", - "description": "Unique ID for the API token.", - "type": "string", - "required": true + "$ref": "#/parameters/ExportId" } ], "responses": { @@ -1118,6 +2280,36 @@ } } }, + "/dataExport/exports/{exportId}/destinations": { + "get": { + "operationId": "Exports_ListDestinations", + "summary": "List all destinations connected to the given export.", + "x-ms-examples": { + "List all destinations in given export": { + "$ref": "./examples/dataexports_exports_destinations_list.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/Version" + }, + { + "$ref": "#/parameters/ExportId" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DestinationCollection" + } + } + } + } + }, "/deviceGroups": { "get": { "operationId": "DeviceGroups_List", @@ -1148,7 +2340,7 @@ "/deviceTemplates": { "get": { "operationId": "DeviceTemplates_List", - "summary": "Get the list of device templates in an application", + "summary": "Get the list of device templates in an application with basic ODATA support ($top, $filter, $orderby), [more details](https://aka.ms/iotcentralodatasupport).", "x-ms-examples": { "List device templates": { "$ref": "./examples/devicetemplates_list.json" @@ -1157,6 +2349,15 @@ "parameters": [ { "$ref": "#/parameters/Version" + }, + { + "$ref": "#/parameters/filter" + }, + { + "$ref": "#/parameters/top" + }, + { + "$ref": "#/parameters/orderBy" } ], "x-ms-pageable": { @@ -1177,7 +2378,7 @@ "operationId": "DeviceTemplates_Get", "summary": "Get a device template by ID", "x-ms-examples": { - "Get a device template by Id": { + "Get a device template by ID": { "$ref": "./examples/devicetemplates_get.json" } }, @@ -1237,7 +2438,7 @@ "summary": "Update the cloud properties and overrides of an existing device template via patch.", "x-ms-examples": { "Update a device template": { - "$ref": "./examples/devicetemplates_create.json" + "$ref": "./examples/devicetemplates_update.json" } }, "parameters": [ @@ -1271,7 +2472,7 @@ "summary": "Delete a device template", "description": "Delete an existing device template by device ID.", "x-ms-examples": { - "Delete a device template by Id": { + "Delete a device template by ID": { "$ref": "./examples/devicetemplates_delete.json" } }, @@ -1293,7 +2494,7 @@ "/devices": { "get": { "operationId": "Devices_List", - "summary": "Get the list of devices in an application", + "summary": "Get the list of devices in an application with basic ODATA support ($top, $filter, $orderby), [more details](https://aka.ms/iotcentralodatasupport).", "x-ms-examples": { "List devices": { "$ref": "./examples/devices_list.json" @@ -1302,6 +2503,15 @@ "parameters": [ { "$ref": "#/parameters/Version" + }, + { + "$ref": "#/parameters/filter" + }, + { + "$ref": "#/parameters/top" + }, + { + "$ref": "#/parameters/orderBy" } ], "x-ms-pageable": { @@ -1323,7 +2533,7 @@ "summary": "Get a device by ID", "description": "Get details about an existing device by device ID.", "x-ms-examples": { - "Get device by Id": { + "Get device by ID": { "$ref": "./examples/devices_get.json" } }, @@ -2537,6 +3747,171 @@ } } }, + "/devices/{deviceId}/relationships/": { + "get": { + "operationId": "Devices_ListRelationships", + "summary": "Given the ID for an upstream device, will return the upstream and the downstream relationships associated with that gateway. These downstream relationships are only those associated with the direct downstream level (they don’t work recursively).", + "description": "List all relationships based on device ID", + "x-ms-examples": { + "List device relationships": { + "$ref": "./examples/devices_relationships_list.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/Version" + }, + { + "$ref": "#/parameters/DeviceId" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DeviceRelationshipCollection" + } + } + } + } + }, + "/devices/{deviceId}/relationships/{relationshipId}": { + "get": { + "operationId": "Devices_GetRelationship", + "summary": "Given the ID for a device and a relationship ID associated with this device, get the details of the relationship.", + "description": "Get device relationship by ID", + "x-ms-examples": { + "Get device relationship by ID": { + "$ref": "./examples/devices_relationships_get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/Version" + }, + { + "$ref": "#/parameters/DeviceId" + }, + { + "$ref": "#/parameters/RelationshipId" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DeviceRelationship" + } + } + } + }, + "put": { + "operationId": "Devices_CreateRelationship", + "summary": "Given the ID for a device and a relationship ID associated with this device, create a new relationship for between the given device and a second device specified in the body.", + "description": "Create a device relationship", + "x-ms-examples": { + "Create a new device relationship": { + "$ref": "./examples/devices_relationships_create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/Version" + }, + { + "$ref": "#/parameters/DeviceId" + }, + { + "$ref": "#/parameters/RelationshipId" + }, + { + "in": "body", + "name": "body", + "description": "Device relationship body.", + "schema": { + "$ref": "#/definitions/DeviceRelationship" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DeviceRelationship" + } + } + } + }, + "patch": { + "operationId": "Devices_UpdateRelationship", + "summary": "Patch a given relationship given the relationship ID and a given device ID.", + "description": "Update device relationship", + "x-ms-examples": { + "Update a device relationship": { + "$ref": "./examples/devices_relationships_update.json" + } + }, + "consumes": [ + "application/json", + "application/json-patch+json" + ], + "parameters": [ + { + "$ref": "#/parameters/Version" + }, + { + "$ref": "#/parameters/DeviceId" + }, + { + "$ref": "#/parameters/RelationshipId" + }, + { + "in": "body", + "name": "body", + "description": "Device relationship patch body.", + "schema": { + "type": "object" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DeviceRelationship" + } + } + } + }, + "delete": { + "operationId": "Devices_RemoveRelationship", + "summary": "Given the ID for a device and an associated relationship ID, delete the relationship. The given device ID can be that of the upstream or downstream device.", + "description": "Delete a device relationship", + "x-ms-examples": { + "Delete a device relationship": { + "$ref": "./examples/devices_relationships_delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/Version" + }, + { + "$ref": "#/parameters/DeviceId" + }, + { + "$ref": "#/parameters/RelationshipId" + } + ], + "responses": { + "204": { + "description": "Success" + } + } + } + }, "/devices/{deviceId}/telemetry/{telemetryName}": { "get": { "operationId": "Devices_GetTelemetryValue", @@ -2694,7 +4069,7 @@ "summary": "Get a job by ID", "description": "Get details about a running or completed job by job ID.", "x-ms-examples": { - "Get a job by Id": { + "Get a job by ID": { "$ref": "./examples/jobs_get.json" } }, @@ -2868,7 +4243,7 @@ "/organizations": { "get": { "operationId": "Organizations_List", - "summary": "Get the list of organizations the user has access to in an application.", + "summary": "Get the list of organizations the user has access to in an application", "x-ms-examples": { "List organizations": { "$ref": "./examples/organizations_list.json" @@ -3029,6 +4404,39 @@ } } }, + "/query": { + "post": { + "operationId": "Query_Run", + "summary": "Run a query and obtain the result", + "x-ms-examples": { + "List devices": { + "$ref": "./examples/query_run.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/Version" + }, + { + "in": "body", + "name": "body", + "description": "query, more details in [IoT central query language](https://aka.ms/iotcql)", + "schema": { + "$ref": "#/definitions/QueryRequest" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/QueryResponse" + } + } + } + } + }, "/roles": { "get": { "operationId": "Roles_List", @@ -3061,7 +4469,7 @@ "operationId": "Roles_Get", "summary": "Get a role by ID.", "x-ms-examples": { - "Get role by Id": { + "Get role by ID": { "$ref": "./examples/roles_get.json" } }, @@ -3281,6 +4689,14 @@ "type": "string", "required": true }, + "DestinationId": { + "in": "path", + "name": "destinationId", + "description": "Unique ID for the destination.", + "x-ms-parameter-location": "method", + "type": "string", + "required": true + }, "DeviceId": { "in": "path", "name": "deviceId", @@ -3297,6 +4713,14 @@ "type": "string", "required": true }, + "ExportId": { + "in": "path", + "name": "exportId", + "description": "Unique ID for the export.", + "x-ms-parameter-location": "method", + "type": "string", + "required": true + }, "JobId": { "in": "path", "name": "jobId", @@ -3313,6 +4737,14 @@ "type": "string", "required": true }, + "RelationshipId": { + "in": "path", + "name": "relationshipId", + "description": "Unique ID of a relationship between devices.", + "x-ms-parameter-location": "method", + "type": "string", + "required": true + }, "Subdomain": { "in": "path", "name": "subdomain", @@ -3339,6 +4771,30 @@ "1.1-preview" ], "required": true + }, + "filter": { + "in": "query", + "name": "$filter", + "description": "Filter string for results.", + "x-ms-parameter-location": "method", + "type": "string", + "required": false + }, + "orderBy": { + "in": "query", + "name": "$orderby", + "description": "The order by string for results.", + "x-ms-parameter-location": "method", + "type": "string", + "required": false + }, + "top": { + "in": "query", + "name": "$top", + "description": "Page size of returned results.", + "x-ms-parameter-location": "method", + "type": "integer", + "required": false } }, "securityDefinitions": { From ed77e3bf7cc3595912fc26f5b2864bd93174e6fb Mon Sep 17 00:00:00 2001 From: Bhaskar Annamalai Date: Wed, 27 Oct 2021 18:11:49 -0700 Subject: [PATCH 19/19] adding parameters for dataflow activity --- .../Microsoft.Synapse/stable/2020-12-01/artifacts.json | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/artifacts.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/artifacts.json index 6c1aa54b7566..d18b774130f2 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/artifacts.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/artifacts.json @@ -471,6 +471,10 @@ "datasetParameters": { "type": "object", "description": "Reference data flow parameters from dataset." + }, + "parameters": { + "$ref": "#/definitions/ParameterValueSpecification", + "description": "Data flow parameters" } }, "additionalProperties": {